Nightclub Party Music

    vexdb
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.1 • Public • Published

    VexDB

    Build Status codecov npm

    vexdb is a wrapper for VexDB.

    Features

    Installation

    Install this package with yarn:

    yarn add vexdb
    

    or, if you want to use npm:

    npm i vexdb
    

    API Primer

    GET

    Retrieves data from an endpoint with the specified parameters. These parameters can include any that can be specified to VexDB, as well as final values in the response object.

    Normally, vexdb limits responses to 5000 items per request. vexdb will make enough requests to ensure that all applicable matches are returned

    // Get all events in StarStruck
    var vexdb = require("vexdb");
    vexdb.get("events", { season: "StarStruck" }).then(console.log);
     
    // Get all teams from California
    vexdb
      .get("teams", {
        region: "California",
      })
      .then(console.log);

    Size

    This works basically identically to .get(), but returns the number of items that fit this result.

    // Get the number of all teams in California
    vexdb.size("teams", { region: "California" }).then(console.log);
     
    // All examples from .get() above would work here...

    Depending on the parameters specified, size() may or may not send nodata requests. In order to minimize bandwidth, you'll want to only include parameters that can be passed directly to VexDB

    Defaults

    In many cases, you'll want to share headers and parameters across requests. This can be done using vexdb.constants.header and vexdb.constants.param, respectively:

    vexdb.constants.param({
      region: "California",
    });
     
    vexdb.constants.header({
      "User-Agent": "<custom user agent string>",
    });

    Warning: Because of the Cross Origin Policy, setting headers using vexdb.constants.header may cause the browser to automatically block requests to https://api.vexdb.io. It is not reccomended to use headers in the browser.

    Caching

    Since VexDB only updates every 4 minutes, this module will prevent repeat requests by resolving them with the previous value immediately. You can control this behavior with vexdb.cache

    Note: vexdb uses my own keya module to handle cache. In Node, caching will take place using sqlite, while in the browser, caches will be stored first in IndexedDB

    Update the Time To Live for new caches

    vexdb.cache.setTTL(60 * 1000);

    See if a cache is present

    vexdb.cache
      .has("teams", {
        region: "South Carolina",
      })
      .then(console.log); // Boolean

    Directly resolve a cached value

    vexdb.cache.resolve("skills", { region: "Utah" }).then(console.log); // The resolved value, or undefined if the cache isn't present

    Clear the cache

    vexdb.cache.clear().then(() => console.log("Cache has been cleared"));

    Live

    This module also supports basic live features. Specify an endpoint and parameters (passed through to get()) and recieve updates on new items that fit that criteria

    vexdb
      .live("matches", {
        scored: 1,
        sku: "RE-VRC-17-3805",
      })
      .on("item", console.log);

    Note that the item event will trigger for every result on the inital poll. This means that every item that fits the parameters will be passed to item. If you do not want this to be the case, specify prefetch: true in your listed parameters

    // Only new matches will trigger item
    vexdb
      .live("matches", {
        scored: 1,
        sku: "RE-VRC-17-3805",
        prefetch: true,
      })
      .on("item", console.log);

    Events

    fetch

    • newItems Object[]

    Emitted on a successful fetch

    prefetch

    • results Object[]

    Emitted when a prefetch has been completed

    item

    • item Object

    Emitted for each new item

    close

    Emitted for each new item


    API

    close(): undefined Stop new polls

    params(newParams: Object): Object Override request parameters for future requests. Note: this does not change the current index of results

    current(): Object[] Returns the current cache of results

    Install

    npm i vexdb

    DownloadsWeekly Downloads

    72

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    95.5 kB

    Total Files

    50

    Last publish

    Collaborators

    • mayormonty