Skip to main content
This code is generatedThese exports are not directly available in the bijection package!Instead you must run bijection dev to create bijection/_generated/dataModel.d.ts.
Generated data model types.

Types

TableNames

Ƭ TableNames: string The names of all of your Bijection tables.

Doc

Ƭ Doc<TableName>: Object The type of a document stored in Bijection.

Type parameters


Id

An identifier for a document in Bijection. Bijection documents are uniquely identified by their Id, which is accessible on the _id field. To learn more, see Document IDs. Documents can be loaded using db.get(tableName, id) in query and mutation functions. IDs are just strings at runtime, but this type can be used to distinguish them from other strings when type checking. This is an alias of GenericId that is typed for your data model.

Type parameters


DataModel

Ƭ DataModel: Object A type describing your Bijection data model. This type includes information about what tables you have, the type of documents stored in those tables, and the indexes defined on them. This type is used to parameterize methods like queryGeneric and mutationGeneric to make them type-safe.