@art-of-coding/lime NPM

Lime

A small middleware package that uses async/await, ~~heavily inspired~~ almost verbatim copied from koa.

Install

npm i @art-of-coding/lime

API

new Lime()

import Lime from '@art-of-coding/lime'

const app = new Lime<TContext>(): Application<TContext>

Create a new Lime app instance. The TContext key refers to the context definition to use.

import Lime from '@art-of-coding/lime'

// Create custom context interface
interface MyContext {
  age: number
}

const app = new Lime<MyContext>()
// now the context will have a property definition <number>age

app.use()

app.use(...middlewares: Middleware<TContext>[]): this

Add one or more middleware functions to the stack.

A Middleware is an async function that takes the context (ctx) for the call as the first argument, and the next() function as the second. Calling next() resumes calling of the middleware stack.

app.use(async (ctx, next) => {
  console.log('before next()')
  await next()
  console.log('after next()')
})

app.compose()

app.compose(): (ctx: TContext, next?: NextFunction) => Promise<void>

Composes the middleware stack into a single middleware function.

Also see @art-of-coding/compose for the stand-alone compose function.

const ctx = { /* ... */ }
const composed = app.compose()

composed(ctx).then(() => {
  // middleware completed
}).catch(err => {
  // middleware error
})

app.run()

app.run(ctx: C, next?: () => Promise<void>): Promise<void>

Compose and run the middleware stack.

const ctx = {}

app.run(ctx).then(() => {
  // middleware completed
}).catch(err => {
  // middleware error
})

Example

Also see http-example.ts for a more complete, practical example.

import Lime from '@art-of-coding/lime'

// Create a new Lime app
const app = new Lime()

// Add middleware function
app.use(async (ctx, next) => {
  ctx.no = 1
  // Run through the rest of the stack
  await next()
})

app.use(async ctx => {
  ctx.middleware = true
  // no next() here
})

// Create a context
const ctx = {}

// Run the middlewares for the context
app.run(ctx).then(() => {
  /*
  `ctx` will now look like this:
  
  {
    no: 1,
    middleware: true
  }
   */
  console.log(ctx)
}).catch(err => {
  console.error(err)
})