EntitiesAPI
Defined in: namespaces-core-plugins.ts:426
Universal entity-resolution plane (fn-93). 6 v1 entity types plus plugin-attached fields.
NOTE: There is deliberately NO delete method (AD-FN93-50).
fn-93
Methods
Section titled “Methods”getType()
Section titled “getType()”getType(
entityType):Promise<AnyJSONValue>
Defined in: namespaces-core-plugins.ts:428
Gets an entity type definition, or null. [entities.read]
Parameters
Section titled “Parameters”entityType
Section titled “entityType”string
Returns
Section titled “Returns”Promise<AnyJSONValue>
listTypes()
Section titled “listTypes()”listTypes(
opts?):Promise<AnyJSONValue[]>
Defined in: namespaces-core-plugins.ts:430
Lists entity type definitions. [entities.read]
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<AnyJSONValue[]>
get(
entityType,entityId,opts?):Promise<EntityRecord|null>
Defined in: namespaces-core-plugins.ts:432
Gets a single entity record, or null. [entities.read]
Parameters
Section titled “Parameters”entityType
Section titled “entityType”string
entityId
Section titled “entityId”string
Returns
Section titled “Returns”Promise<EntityRecord | null>
query()
Section titled “query()”query(
query):Promise<EntityQueryResult>
Defined in: namespaces-core-plugins.ts:434
Runs a v1 query envelope (operator-allowlisted, depth-capped). [entities.read]
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<EntityQueryResult>
watch()
Section titled “watch()”watch(
entityType,handler,opts?):Promise<string>
Defined in: namespaces-core-plugins.ts:436
Watches an entity type. Returns a token. [entities.read]
Parameters
Section titled “Parameters”entityType
Section titled “entityType”string
handler
Section titled “handler”(change) => void
Returns
Section titled “Returns”Promise<string>
unwatch()
Section titled “unwatch()”unwatch(
token):Promise<void>
Defined in: namespaces-core-plugins.ts:438
Cancels a watch.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
upsert()
Section titled “upsert()”upsert(
entityType,partialRecord):Promise<EntityRecord>
Defined in: namespaces-core-plugins.ts:440
Upserts an entity record. [entities.write]
Parameters
Section titled “Parameters”entityType
Section titled “entityType”string
partialRecord
Section titled “partialRecord”Partial<EntityRecord>
Returns
Section titled “Returns”Promise<EntityRecord>