Interface: IdentityDefinition¶

An identifier for a schema, allowing other schemas to reference it.

You may optionally specify an ObjectSchemaDefinition.identity when defining an object schema. This signals that this schema represents an important named entity in the context of your pack. Schemas with identities may be referenced by other schemas, in which case Superhuman Docs will render such values as @-references in the doc, allowing you to create relationships between entities.

Every sync table's top-level schema is required to have an identity. However, an identity will be created on your behalf using the SyncTableOptions.identityName that you provide in the sync table definition, so you needn't explicitly create one unless desired.

Extended by¶

Identity

Properties¶

attribution?¶

optional attribution: AttributionNode[]

Defined in: schema.ts:1006

Deprecated¶

See ObjectSchemaDefinition.attribution

dynamicUrl?¶

optional dynamicUrl: string

Defined in: schema.ts:994

The dynamic URL, if this is a schema for a dynamic sync table. When returning a schema from the DynamicSyncTableOptions.getSchema formula of a dynamic sync table, you must include the dynamic URL of that table, so that rows in this table may be distinguished from rows in another dynamic instance of the same table.

When creating a reference to a dynamic sync table, you must include the dynamic URL of the table you wish to reference, again to distinguish which table instance you are trying to reference.

name¶

name: string

Defined in: schema.ts:982

The name of this entity. This is an arbitrary name but should be unique within your pack. For example, if you are defining a schema that represents a user object, "User" would be a good identity name.

packId?¶

optional packId: number

Defined in: schema.ts:996

The ID of another pack, if you are trying to reference a value from different pack.