@docstack/react
Interfaces
| Interface | Description |
|---|---|
| ClassModel | Document-modelling types, re-exported from @docstack/client. |
| DocStackSyncOptions | Options for DocStack.sync, which starts one handle per stack. |
| DomainModel | Document-modelling types, re-exported from @docstack/client. |
| InternalDocFilterOptions | Options controlling which of DocStack's own documents stay on this device. |
| Patch | Document-modelling types, re-exported from @docstack/client. |
| StackSyncOptions | Options for ClientStack.sync. |
| SyncStatus | A point-in-time reading of one stack's replication. |
| TriggerModel | Document-modelling types, re-exported from @docstack/client. |
Type Aliases
| Type Alias | Description |
|---|---|
| AttributeModel | Document-modelling types, re-exported from @docstack/client. |
| AttributeType | Document-modelling types, re-exported from @docstack/client. |
| AttributeTypeConfig | Document-modelling types, re-exported from @docstack/client. |
| ClientCredentials | Document-modelling types, re-exported from @docstack/client. |
| DocstackReady | Document-modelling types, re-exported from @docstack/client. |
| Document | Document-modelling types, re-exported from @docstack/client. |
| RelationDocument | Document-modelling types, re-exported from @docstack/client. |
| RemoteResolver | How a stack finds its remote. |
| SelectAST | Document-modelling types, re-exported from @docstack/client. |
| StackConfig | Document-modelling types, re-exported from @docstack/client. |
| StackOptions | Document-modelling types, re-exported from @docstack/client. |
| SyncDirection | Which way documents move. |
| SyncState | Where a stack's replication currently stands. |
| UnionAST | Document-modelling types, re-exported from @docstack/client. |
Variables
| Variable | Description |
|---|---|
| DocStackContext | Context object for the DocStack instance. It provides the current DocStack instance or null if not initialized. |
Functions
| Function | Description |
|---|---|
| StackProvider | A provider component that initializes the DocStack client and makes it available to child components via the useDocStack hook. |
| useClass | Hook to retrieve a single Class instance by name. |
| useClassCreate | Hook to create a new Class in a specific stack. |
| useClassDocs | Hook to retrieve documents (cards) of a specific class. Maintains a real-time list of documents matching the query. |
| useClassList | Hook to retrieve a list of classes from a stack based on a selector. Maintains a real-time list of classes matching the selector. |
| useDocStack | Hook to access the DocStack instance. |
| useDomain | Hook to retrieve a single Domain instance by name. |
| useDomainCreate | Hook to create a new Domain in a specific stack. |
| useDomainList | Hook to retrieve a list of domains from a stack based on a selector. Maintains a real-time list of domains matching the selector. |
| useDomainRelations | Hook to retrieve relation documents for a specific domain. Maintains a real-time list of relations matching the query. |
| useFind | Hook to find documents in a stack using a Mango selector. |
| useQuerySQL | - |
| useSyncStatus | Subscribes to replication state for one stack, or for all of them. |