README.md

Remoteconfig

(remoteconfig)

Overview

Available Operations

• getConfig - Get Configurations

getConfig

Get Configurations

Example Usage

import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.remoteconfig.getConfig();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { OrqCore } from "@orq-ai/node/core.js";
import { remoteconfigGetConfig } from "@orq-ai/node/funcs/remoteconfigGetConfig.js";

// Use `OrqCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const orq = new OrqCore({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const res = await remoteconfigGetConfig(orq);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.RemoteConfigsGetConfigRequestBody	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.RemoteConfigsGetConfigResponseBody>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	*/*