🔀API Design

Learn about the flow state design of the API

The API is designed as a flow state with several branches. You always start at the top and move forward with each command in the branches, until you hit an endpoint, which either executes a command or returns a query result.

Note: fetch() endpoints will always return a bookmark, which you can reenter with the query property.

Example:

const library = wranglebot.query.library.one("mylibrary").fetch();

library.query.metafiles.many().fetch(); //returns all metafiles in the library

Download the Chart in Full Size:

2MB

WrangleBot NodeJS API.png

image

Open