Atlas

Appearance

Type Alias: AttributeString ​

AttributeString = object

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:617

AttributeString

Properties ​

$createdAt ​

$createdAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:645

Attribute creation date in ISO 8601 format.

$updatedAt ​

$updatedAt: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:649

Attribute update date in ISO 8601 format.

array? ​

optional array?: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:641

Is attribute an array?

default? ​

optional default?: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:657

Default value for attribute when not provided. Cannot be set when attribute is required.

encrypt? ​

optional encrypt?: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:661

Defines whether this attribute is encrypted or not.

error ​

error: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:633

Error message. Displays error generated on failure of creating or deleting an attribute.

key ​

key: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:621

Attribute Key.

required ​

required: boolean

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:637

Is attribute required?

size ​

size: number

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:653

Attribute size.

status ​

status: AttributeStatus

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:629

Attribute status. Possible values: available, processing, deleting, stuck, or failed

type ​

type: string

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:625

Attribute type.