library.md

JavaScript usage

TL;DR

Loading configuration from the file system

import { load } from "@valued-app/config"
import { FsLoader } from "@valued-app/fs-loader"

load(new FsLoader("."), config => console.log(config.toJSON()))

Loading configuration from a GitHub repository

import { load } from "@valued-app/config"
import { GhLoader } from "@valued-app/gh-loader"

const loader = new GhLoader({
  repo: "valued-app/valued-config",
  ref: "main", // optional
  token: process.env.GITHUB_TOKEN
})

load(loader, config => console.log(config.toJSON()))

Programmatically generating configuration

import { Config } from "@valued-app/config"

const config = new Config()

// adding some configuration manually
config.add("goals", [{
  name: "An example goal",
  actionKey: "example"
}])

// loading configuration from a "file"
config.addFile({
  path: "valued/goals.toml",
  content: `
    ["Example goal"]
    action-key = "action1"

    ["Other goal"]
    action-key = "action2"
    threshold = 5
  `
})

// output the API payload
const payload = config.toJSON()
console.log(payload)

This will output:

{
  "category": "config",
  "data": {
    "goals": [
      { "name": "An example goal", "action_key": "example" },
      { "name": "Example goal", "action_key": "action1" },
      { "name": "Other goal", "action_key": "action2", "threshold": 5 }
    ]
  }
}

Pushing a configuration to Valued

import { Config } from "@valued-app/config"
import { FsLoader } from "@valued-app/fs-loader"

// settings
const path = "./my_repo"
const token = "secret Valued token"

// code to load config and push it
const loader = new FsLoader(path)
Config.load(loader).then(config => config.push(token))

This will use the standardized fetch API under the hood, as is implemented by all modern browsers, Deno, and Node.js 18 or higher. For Node.js versions prior to 18, you need to install a polyfill, such as node-fetch.

You can also pass your own, fetch-compatible function via a configuration option:

const config = new Config(null, {
  // signature: (url: string, options: any) => Promise<{ json(): any }>
  fetch: (url, options) => {
    // this implementation won't actually do anything
    return Promise.resolve({
      json: () => Promise.resolve({ status: "ok" })
    })
  }
})

await config.load(loader)
await config.push(token)

Full documentation

You can generate API docs using npm run docs (output will be in the html directory).