1.0.111 • Published 5 years ago
@jkreitzman/domojs v1.0.111
DomoJs
This module use of Domo's API (ryuu.js) by providing both typescript types and functions for common API actions.
This library uses ryuu.js version 2.6.5
.
Installation & Usage
This package is hosted on NPM. To install:
npm i @jkreitzman\domojs
To use this library in node:
import domo = require("@jkreitzman\domojs");
The library also includes TypeScript definitions, to allow for use in a TS project. If using TypeScript, we recommend you create an interface that extends AppDb.Document and override the content property to allow strong-typing to your database. For example, if storing user preferences, your interface might look like this:
interface MyDocument extends AppDb.Document {
content: {
userId: number;
preferences: string;
}
}
Project Structure
- src: Source typescript.
- dist: Bundled output, ready for distribution.
- scripts: Build scripts.
- types: Type definitions for Domo's Javascript library, ryuu.js (domo.js)