Class DataPowers

throws

{TypeError} when keyOrFilename is missing.

remarks

Retrieving data for DataType.Json will not maintain order of keys within JSON objects (and arrays).

example

Getting different types of data from within your skill code

// Ensure you import DataPowers
import { DataPowers, DataScope, CsvParseOptions } from "@andi/powers";

const key = "my-key-name-here";
// getting a number
const counter = await DataPowers.get<number>(key);
// getting a complex object from different `scope`
const obj = await DataPowers.get<any>(key, { scope: DataScope.Organization });
// getting a text file data
const textData = await DataPowers.get<string>("my-text-file.txt", { type: DataType.File, parseOptions: "text" });
// getting raw buffer from a file
const buf = await DataPowers.get<Buffer>("sample-file.txt", { type: DataType.File, scope: DataScope.Organization, parseOptions: "buffer" });
// getting csv rows
type MyRow = {
    id: string;
    city: string;
    zip: string;
};
const csvParseOptions: CsvParseOptions = { delimiter: ","};
const csvRows = await DataPowers.get<MyRow[]>("my-test.csv", { type: DataType.File, parseOptions: csvParseOptions });

After first time create, can only update cache expiration settings.

throws

{RangeError} when unknown collection type

throws

{TypeError} collectionName or options are invalid

throws

{RangeError} when collectionName length is >512 length

throws

{Error} various errors for invalid option configurations. See CollectionOptions for more information

example

Creating a collection

// Ensure you import DataPowers
import { DataPowers, CollectionType, CollectionExpirationMode } from "@andi/powers";

type MyApproval = {
    processId?: string;
    isApproved: boolean;
};

const approvals = await DataPowers.getOrCreateCollection<MyApproval>(CollectionType.Dictionary, "approvals");
await approvals.set("newBusinessOpportunity", { isApproved: true });

example

Creating a collection that never expires

// Ensure you import DataPowers
import { DataPowers, CollectionType, CollectionExpirationMode } from "@andi/powers";

type MyApproval = {
    processId?: string;
    isApproved: boolean;
};

const approvals = await DataPowers.getOrCreateCollection<MyApproval>(CollectionType.Dictionary, "approvals", { expiry: { expireMode: CollectionExpirationMode.Never } });
await approvals.set("newBusinessOpportunity", { isApproved: true });

example

Creating an append log

// Ensure you import DataPowers
import { DataPowers, CollectionType, CollectionExpirationMode } from "@andi/powers";

type FiSkillLog = {
    data: string;
};

const someData = "";
const skillLogs = await DataPowers.getOrCreateCollection<FiSkillLog>(CollectionType.Dictionary, "log", { expiry: { expireMode: CollectionExpirationMode.Never } });
// Use uuid generator or another unique partition to negate or minimize key collision
await skillLogs.set(PowerHelpers.uuid(), { data: someData });
const allLogs = await skillLogs.values();
// alternatively use entries to review logs by `createdAt`, `updatedAt`
const allLogEntries = await skillLogs.entries();
// sort by descending
allLogEntries.sort((a, b) => b.createdAt.getTime() - a.createdAt.getTime());
const lastLog = allLogEntries[0];

throws

{TypeError} when keyOrFilename is missing.

throws

{TypeError} when searchOptions is missing.

remarks

No guarantee of order of keys within JSON objects (and arrays).

example

Searching data rows from within a skill code

// Ensure you import DataPowers
import { DataPowers, Condition, Operator } from "@andi/powers";

// searching data rows - exampleRows below shows how your csv data will represent in JavaScript
const exampleRows = [{rateType: "floating", rate: 10, region: "FL"}, {rateType: "fixed", rate: 12, region: "FL"}, {rateType: "floating", rate: 11, region: "NC"}];
const condition: Condition = { key: "region", operator: Operator.Equals, value: "FL" };
const searchOptions: SearchOptions = { where: condition, select: ["rateType", "rate"]};
const results = await DataPowers.search<any>("my-test.csv", searchOptions);
// your results array will look like [{rateType: "floating", rate: 10}, {rateType: "fixed", rate: 12}]

throws

{TypeError} when keyOrFilename is missing.

throws

{TypeError} when value is missing.

throws

{RangeError} when value is greater than 256 KB for DataType.Json or 1 MB for DataType.File.

example

Setting different types of data from within a skill code

// Ensure you import DataPowers
import { DataPowers, DataScope, DataType } from "@andi/powers";

const key = "my-key-name-here";
// setting a number
await DataPowers.set<number>(key, 10);
// setting a complex object
const obj = { a: "test", b: 1, c: true};
await DataPowers.set<any>(key, obj, { scope: DataScope.Organization });
// setting a text file data
const textData = await DataPowers.set<string>("my-text-file.txt", "sample test here", { scope: DataScope.Skill, type: DataType.File });
// setting raw buffer in a file
await DataPowers.set<Buffer>("sample-file.txt", Buffer.from("sample test"), { scope: DataScope.Skill, type: DataType.File});