domojsdeprecated

A wrapper around commonly used Domo API functions.

Usage no npm install needed!

<script type="module">
  import domojs from 'https://cdn.skypack.dev/domojs';
</script>

README

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 domojs

To use this library in node: import domo = require("domojs");

The library also includes TypeScript definitions. If using TypeScript, I recommend you create an interface that extends AppDb.Document and override the content property to allow strong-typing to AppDb. For example, if storing user preferences, your interface might look like this:

import { AppDb } from "domojs/dist/AppDb";

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)