Skip to main content

Constants And Variables

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

Constants

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

Create Constants

To create a constant, refer to the example below

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);

The following fields are allowed

  • key: the unique identifier field
  • value: the value to be stored
  • type: the Data Type, further description provided below
  • description: a description of the field and what it entails optional

The DataTypes are below

Here is the DataTypes enum converted into a markdown table:

KeyValue
STRINGstring
NUMBER_STRINGnumberstring
INTEGERnumber
FLOATfloat
DOUBLEdouble
UUIDuuid
ARRAYarray
OBJECTobject
BOOLEANboolean

Update Constants

To update an existing constant, refer to the example below

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

// ... app builder instance

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);

Fetch Constants

const constants = ductape.app.constant.fetchAll(); // fetch all app constants
const key = "USER_TYPE"
const constant = ductape.app.constant.fetch(key) // fetch single variable

Variables

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

Create Variables

To create a variable, refer to the example below

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);

Update Variables

To update an existing variables, refer to the example below

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);

Fetch Variables

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