Class Person

A Person Database object that represents Person.

Index

Constructors

Properties

expireAt? externalId? groups? id? metadata? name? ttl? updatedAt?

Accessors

Constructors

constructor

new Person(): Person

Returns Person

Properties

`Optional`expireAt

expireAt?: Date | null

`Optional`externalId

externalId?: string | null

`Optional`groups

groups?: string[] | null

Array if Group IDs Person belongs to.

`Optional`id

id?: string | null

`Optional`metadata

metadata?: any

A free-form object containing Person extended attributes. Updatable field.

`Optional`name

name?: string | null

Person name. Updatable field.

`Optional`ttl

ttl?: number | null

`Optional`updatedAt

updatedAt?: Date | null

Person update date.

Accessors

createdAt

get createdAt(): Date | null
Returns Date | null
- Defined in person_database/person.d.ts:8