TinyBase logoTinyBase β

ProviderProps

ProviderProps props are used with the Provider component, so that Store, Metrics, Indexes, Relationships, Queries, and Checkpoints objects can be passed into the context of a Svelte 5 application and used throughout.

{
  store?: Store;
  storesById?: {[id: Id]: Store};
  metrics?: Metrics;
  metricsById?: {[id: Id]: Metrics};
  indexes?: Indexes;
  indexesById?: {[id: Id]: Indexes};
  relationships?: Relationships;
  relationshipsById?: {[id: Id]: Relationships};
  queries?: Queries;
  queriesById?: {[id: Id]: Queries};
  checkpoints?: Checkpoints;
  checkpointsById?: {[id: Id]: Checkpoints};
  persister?: AnyPersister;
  persistersById?: {[id: Id]: AnyPersister};
  synchronizer?: Synchronizer;
  synchronizersById?: {[id: Id]: Synchronizer};
  children: Snippet;
}
TypeDescription
store?Store

A default single Store object that will be available within the Provider context.

storesById?{[id: Id]: Store}

An object containing multiple Store objects that will be available within the Provider context by their Id.

metrics?Metrics

A default single Metrics object that will be available within the Provider context.

metricsById?{[id: Id]: Metrics}

An object containing multiple Metrics objects that will be available within the Provider context by their Id.

indexes?Indexes

A default single Indexes object that will be available within the Provider context.

indexesById?{[id: Id]: Indexes}

An object containing multiple Indexes objects that will be available within the Provider context by their Id.

relationships?Relationships

A default single Relationships object that will be available within the Provider context.

relationshipsById?{[id: Id]: Relationships}

An object containing multiple Relationships objects that will be available within the Provider context by their Id.

queries?Queries

A default single Queries object that will be available within the Provider context.

queriesById?{[id: Id]: Queries}

An object containing multiple Queries objects that will be available within the Provider context by their Id.

checkpoints?Checkpoints

A default single Checkpoints object that will be available within the Provider context.

checkpointsById?{[id: Id]: Checkpoints}

An object containing multiple Checkpoints objects that will be available within the Provider context by their Id.

persister?AnyPersister

A default single Persister object that will be available within the Provider context.

persistersById?{[id: Id]: AnyPersister}

An object containing multiple Persister objects that will be available within the Provider context by their Id.

synchronizer?Synchronizer

A default single Synchronizer object that will be available within the Provider context.

synchronizersById?{[id: Id]: Synchronizer}

An object containing multiple Synchronizer objects that will be available within the Provider context by their Id.

childrenSnippet

The children prop of a ProviderProps object — the app subtree that will have access to the provided context.

One of each type of object can be provided as a default within the context. Additionally, multiple of each type of object can be provided in an Id-keyed map to the ___ById props.

Since

v8.1.0