<picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-light-500b%402x.png"> <img alt="Architect Logo" src="https://github.com/architect/assets.arc.codes/raw/main/public/architect-logo-500b%402x.png"> </picture>

@architect/functions

Runtime utility library for Functional Web Apps (FWAs) built with [Architect][https://arc.codes]

Check out the full docs for this library and Architect

Install

Within your Architect project directory, add @architect/function to its root package.json:

npm i @architect/functions

You may also add @architect/function to individual Lambda package.json files, but we suggest making use of Architect's automated Lambda treeshaking. See the Architect dependency management guide for more details.

Usage

let {
  events,   // @events pub/sub
  http,     // @http middleware + tools
  queues,   // @queues pub/sub
  services, // Architect resource / service discovery
  static,   // @static asset helper
  tables,   // @tables DynamoDB helper methods + API client
  ws,       // @ws WebSocket helper + API client
} = require('@architect/functions')

API

@events methods

• events.subscribe()
• events.publish()

@http methods

• http()
• http middleware
• http.session
• http.csrf

@queues methods

• queues.subscribe()
• queues.publish()

Service discovery

• services()

@static

• static()

@tables methods

• tables()
  • table.delete()
  • table.get()
  • table.put()
  • table.query()
  • table.scan()
  • table.scanAll()
  • table.update()
  • table._db
  • table._doc
  • table.name
  • table.reflect()

@ws methods

• ws.send()
• ws.close()
• ws.info()
• ws._api