Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

tote-lib

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

tote-lib

`tote-lib` is a helper library for [Tote](https://github.com/alizahid/tote).

  • 0.0.11
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

tote-lib

tote-lib is a helper library for Tote.

API

tote-lib exports four items.

Func

Func is the class you use to setup your function. It includes several helper methods.

Example
// import dependencies
import { Func, joi } from 'tote-lib'

// create your function
class Hello extends Func {
  // define your schema
  schema = {
    // query parameters
    query: joi.object({
      number: joi.number()
    })
  }

  // define your function here
  invoke() {
    // get query params
    const {
      query: { number = 5 }
    } = this.request

    // return object
    return {
      hello: 'world',
      result: number * 2
    }
  }
}

// bootstrap and export
export default Func.bootstrap(Hello)
Options
NameTypeDescription
contextObjectAzure Function execution context
requestObjectRequest object. Contains body, headers, and query objects with any parameters
status<number>FunctionSet the HTTP status code
send<object>FunctionSet the JSON body
Usage

request

Get input parameters.

// get parameters
const {
  body: { foo },
  query: { name }
} = this.request

// use them

status

this.status(404)

send

You can just return the object from your function. But you can also use send.

this.send({
  foo: 'bar'
})

Exception

Exception extends Error and lets you throw sensible errors from your functions.

Parameters
NameTypeDescriptionDefault
messagestringError message or keyunknown_error
statusnumberHTTP status code500
Usage
throw new Exception('Email required', 400)

invoke

invoke is a helper for invoking functions when writing your tests.

Parameters
NameTypeDescription
namestringFunction name, should correspond to a directory
requestObjectOptional. Request object, may contain body, headers, and query objects
Usage
invoke('hello', {
  headers: {
    authorization: 'Bearer ...'
  },
  query: {
    name: 'Ali'
  }
})

joi

Look at Joi docs.

FAQs

Package last updated on 22 Jun 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc