malijs / metadata-field-auth

Mali base middleware utility for metadata auth field checks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@malijs/metadata-field-auth

Base middleware utility for metadata auth field checks for Mali

npm version build status JavaScript Style Guide License

API

@malijs/metadata-field-auth

Generic Mali metadata field authorization middleware If the call has metadata with "authorization" string property with "{field} {value}" then specified function is called.

Param Type Description
field String Field within the authorization metadata value to look for.
options Options
options.error String | Object | function optional Error creation options. If String the message for Error to throw in case authorization is not present. If Object the error options with message, code, and metadata properties. See create-grpc-error module. If Function a function with signature (ctx) called to create an error. Must return an Error instanse. Default: "Not Authorized"
fn function The middleware function to execute with signature (key, ctx, next)

Example

const fieldAuth = require('@malijs/metadata-field-auth')

app.use(fieldAuth('secret', async (key, ctx, next) => {
  console.log(key)
  await next()
})

License

Apache-2.0

About

Mali base middleware utility for metadata auth field checks

License:Apache License 2.0


Languages

Language:JavaScript 100.0%