Skip to main content

Constants and Variables

Ductape provides interfaces for managing the constants and variables used in your service.

Constants​

Constants are values that do not change and can be reused across multiple actions within your application.

Creating Constants​

import { DataTypes } from "ductape-sdk/types";

const details = {
  key: "USER_TYPE",
  value: "user",
  type: DataTypes.STRING,
  description: "The User Type field, to be used during user registration"
};

const constants = await ductape.app.constant.create(details);

Fields​

  • key: The unique identifier field
  • value: The value to be stored
  • type: The data type (see table below)
  • description: A description of the field and what it entails (optional)

DataTypes Enum​

KeyValue
STRINGstring
NUMBER_STRINGnumberstring
INTEGERnumber
FLOATfloat
DOUBLEdouble
UUIDuuid
ARRAYarray
OBJECTobject
BOOLEANboolean

Updating Constants​

import { DataTypes } from "ductape-sdk/types";

const details = {
  value: "user",
  type: DataTypes.STRING,
  description: "The User Type field, to be used during user registration"
};

const constant = await ductape.app.constant.update(details);

Fetching Constants​

const constants = await ductape.app.constant.fetchAll();
const key = "USER_TYPE";
const constant = await ductape.app.constant.fetch(key);

Variables​

Variables are values that are meant to be supplied by third parties and can be reused across multiple actions within your application. Defining variables is similar to defining constants, but the values are not set by you, but instead by your customers.

Creating Variables​

import { DataTypes } from "ductape-sdk/types";

const details = {
  key: "PUBLIC_KEY",
  type: DataTypes.UUID,
  description: "The User's Public Key"
};

const variable = await ductape.app.variable.create(details);

Updating Variables​

import { DataTypes } from "ductape-sdk/types";

const key = "PUBLIC_KEY";
const update = {
  type: DataTypes.STRING,
  description: "The User's Public Key"
};

const variable = await ductape.app.variable.update(key, update);

Fetching Variables​

const variables = await ductape.app.variable.fetchAll();
const key = "USER_TYPE";
const variable = await ductape.app.variable.fetch(key);

See Also​