Skip to main content

String

String metadata stores text-like values. It is used for readable text, codes, selected option values, single relation IDs, organization structure IDs, member IDs, email addresses, and links.

Choose string handling when the field value should be compared or passed as text, even if the text represents a business code or related record ID.

Common Uses​

UseExamples
Display textName, title, description
Business codeOrder number, customer code, serial number
Single selectionSelect value, radio value
Single relationSearch record ID, foreign key, member ID
Contact textEmail address, URL

Value Shape​

type StringMetadataValue = string | null;

Empty optional fields can be null or an empty string depending on the write source. Normalize before using the value in external API calls.

const orderNo = String(record.data.order_no || '').trim();