Nationwide Polamorous Matrimony
    Wondering what’s next for npm?Check out our public roadmap! »

    @datalanguage/datagraphs-client

    0.1.8 • Public • Published

    Data Graphs Client Lib

    API Client library for Data Graphs

    Documentation for the Data Graphs API can be found under the Developer Docs section of the Data Graphs App

    Install

    npm install --save @datalanguage/datagraphs-client

    Usage

    // Require the library
    const Datagraphs = require("@datalanguage/datagraphs-client");
    
    // Create the Data Graphs client
    const datagraphs = new Datagraphs();

    Examples

    Fetch all datasets

    See https://datalanguage.github.io/datagraphs-client-js/Datasets.html#all

    const datasets = await datagraphs.datasets.all();

    Search concepts

    See https://datalanguage.github.io/datagraphs-client-js/Concepts.html#search

    const concepts = await datagraphs.concepts.search();

    Get an individual concept

    See https://datalanguage.github.io/datagraphs-client-js/Concepts.html#get

    const concept = await datagraphs.concepts.get(conceptId);

    Create a new concept

    See https://datalanguage.github.io/datagraphs-client-js/Concepts.html#create

    const concept = await datagraphs.concepts.create(datasetId, {
      label: "My New Concept",
    });

    Create a new candidate concept

    See https://datalanguage.github.io/datagraphs-client-js/Candidates.html#create

    const candidate = await datagraphs.candidates.create({
      label: "My New Candidate",
    });

    Configuration

    Configuration options can either be passed as parameters to the DataGraphs constructor or set as environment variables. To find these values visit the Applications area of the Data Graphs App

    Constructor Property Environment Variable Description
    accountKey DATAGRAPHS_ACCOUNT_KEY Your Data Graphs account key
    apiKey DATAGRAPHS_API_KEY Your Data Graphs application API key
    clientId DATAGRAPHS_CLIENT_ID Your Data Graphs application client id
    clientSecret DATAGRAPHS_CLIENT_SECRET Your Data Graphs application client secret

    Below is an example of passing these parameters to the Data Graphs client constructor

    const datagraphs = new DataGraphs({
      accountKey: "my-test-account",
      apiKey: "bZiDs4.....",
      clientId: "sR5dfR.....",
      clientSecret: "pRM6kR.....",
    });

    Documentation

    Full documentation for this library can be found at https://datalanguage.github.io/datagraphs-client-js/

    Keywords

    none

    Install

    npm i @datalanguage/datagraphs-client

    DownloadsWeekly Downloads

    64

    Version

    0.1.8

    License

    MIT

    Unpacked Size

    25.1 kB

    Total Files

    25

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar