README.md

Welcome to CuillereJS 🥄

CuillereJS is an extensible asynchronous execution framework based on generator functions.

🚧 CuillereJS is still experimental, APIs may change at any time.

Why ?

The goal of CuillereJS is to abstract some inevitable technical complexity (such as managing database transactions) in plugins, and keep business code as simple and focused as possible.

Usage

In this example we use CuillereJS to manage the connection to a PostgreSQL database.

const cuillere = require('@cuillere/core')
const { poolPlugin, transactionPlugin, queryPlugin } = require('@cuillere/postgres')

const cllr = cuillere(
  poolPlugin({ /* postgres config */ }), // Manages connection pool
  transactionPlugin(), // Manages transactions
  queryPlugin() // Executes queries
)

const addUserAddress = (userId, address, setDefault) => cllr.call(function*() {
  const res = yield query({
    text: `INSERT INTO addresses (userId, street, postalcode, city)
           VALUES ($1, $2, $3, $4)
           RETURNING *`,
    values: [userId, address.street, address.postalCode, address.city]
  })
  if (setDefault) {
    const addressId = res.rows[0].id
    yield query({
      text: `UPDATE users
             SET defaultaddressid = $1
             WHERE userid = $2`,
      values: [addressId, userId]
    })
  }
})

Install

yarn add @cuillere/core

Authors

👤 Valentin Cocaud

• Twitter: @ragorn44
• Github: @EmrysMyrddin

👤 Nicolas Lepage

• Twitter: @njblepage
• Github: @nlepage

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 CuillereJS.
This project is Apache-2.0 licensed.

---

This README was generated with ❤️ by readme-md-generator