Skip to content

Commit

Permalink
docs: add missing doc heads
Browse files Browse the repository at this point in the history
  • Loading branch information
maxnowack committed Jan 6, 2025
1 parent 8cd47a3 commit 231d398
Show file tree
Hide file tree
Showing 9 changed files with 169 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ export default withMermaid({
'/reactivity/usignal/index.html': '/reference/usignal/',
'/reactivity/vue.html': '/reference/vue/',
'/reactivity/vue/index.html': '/reference/vue/',
'/reference/core/index.html': '/reference/',
'/replication.html': '/sync/',
'/replication/appwrite/index.html': '/sync/',
'/replication/firebase/index.html': '/sync/',
Expand Down
24 changes: 24 additions & 0 deletions docs/reference/core/autofetchcollection/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
---
head:
- - link
- rel: canonical
href: https://signaldb.js.org/reference/core/autofetchcollection/
- - meta
- name: og:type
content: article
- - meta
- name: og:url
content: https://signaldb.js.org/reference/core/autofetchcollection/
- - meta
- name: og:title
content: AutoFetchCollection | SignalDB
- - meta
- name: og:description
content: Learn about the AutoFetchCollection in SignalDB, enabling reactive and on-demand data fetching with customizable options like purge delay and persistence adapters.
- - meta
- name: description
content: Learn about the AutoFetchCollection in SignalDB, enabling reactive and on-demand data fetching with customizable options like purge delay and persistence adapters.
- - meta
- name: keywords
content: SignalDB, AutoFetchCollection, reactive data fetching, query-based fetching, data persistence, JavaScript, TypeScript, local-first database, loading state management, on-demand data loading, persistence adapters
---
# AutoFetchCollection

```ts
Expand Down
24 changes: 24 additions & 0 deletions docs/reference/core/collection/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
---
head:
- - link
- rel: canonical
href: https://signaldb.js.org/reference/core/collection/
- - meta
- name: og:type
content: article
- - meta
- name: og:url
content: https://signaldb.js.org/reference/core/collection/
- - meta
- name: og:title
content: Collection | SignalDB
- - meta
- name: og:description
content: Learn about the SignalDB Collection class, a flexible and reactive way to manage and manipulate schemaless data with support for persistence adapters and transformations.
- - meta
- name: description
content: Learn about the SignalDB Collection class, a flexible and reactive way to manage and manipulate schemaless data with support for persistence adapters and transformations.
- - meta
- name: keywords
content: SignalDB, Collection, data management, reactive collections, persistence adapters, TypeScript, JavaScript, schemaless data, field-level reactivity, batch operations
---
# Collection

```ts
Expand Down
24 changes: 24 additions & 0 deletions docs/reference/core/combinepersistenceadapters/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
---
head:
- - link
- rel: canonical
href: https://signaldb.js.org/reference/core/combinepersistenceadapters/
- - meta
- name: og:type
content: article
- - meta
- name: og:url
content: https://signaldb.js.org/reference/core/combinepersistenceadapters/
- - meta
- name: og:title
content: combinePersistenceAdapters | SignalDB
- - meta
- name: og:description
content: Learn how to use combinePersistenceAdapters in SignalDB to merge multiple persistence adapters for enhanced flexibility and performance.
- - meta
- name: description
content: Learn how to use combinePersistenceAdapters in SignalDB to merge multiple persistence adapters for enhanced flexibility and performance.
- - meta
- name: keywords
content: SignalDB, combinePersistenceAdapters, persistence adapters, data management, primary adapter, secondary adapter, TypeScript, JavaScript, data storage
---
# combinePersistenceAdapters

```ts
Expand Down
24 changes: 24 additions & 0 deletions docs/reference/core/createindex/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
---
head:
- - link
- rel: canonical
href: https://signaldb.js.org/reference/core/createindex/
- - meta
- name: og:type
content: article
- - meta
- name: og:url
content: https://signaldb.js.org/reference/core/createindex/
- - meta
- name: og:title
content: createIndex | SignalDB
- - meta
- name: og:description
content: Learn how to use the createIndex function in SignalDB to add single-field indices to collections for faster query performance.
- - meta
- name: description
content: Learn how to use the createIndex function in SignalDB to add single-field indices to collections for faster query performance.
- - meta
- name: keywords
content: SignalDB, createIndex, collection indices, single-field index, performance optimization, data management, TypeScript, JavaScript, indexing, query optimization
---
# createIndex

```ts
Expand Down
24 changes: 24 additions & 0 deletions docs/reference/core/createindexprovider/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
---
head:
- - link
- rel: canonical
href: https://signaldb.js.org/reference/core/createindexprovider/
- - meta
- name: og:type
content: article
- - meta
- name: og:url
content: https://signaldb.js.org/reference/core/createindexprovider/
- - meta
- name: og:title
content: createIndexProvider | SignalDB
- - meta
- name: og:description
content: Discover how to use the createIndexProvider function in SignalDB to build custom index providers for advanced query optimizations in collections.
- - meta
- name: description
content: Discover how to use the createIndexProvider function in SignalDB to build custom index providers for advanced query optimizations in collections.
- - meta
- name: keywords
content: SignalDB, createIndexProvider, custom index providers, query optimization, collection indices, data management, TypeScript, JavaScript, performance enhancement, advanced indexing
---
# createIndexProvider

```ts
Expand Down
24 changes: 24 additions & 0 deletions docs/reference/core/creatememoryadapter/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
---
head:
- - link
- rel: canonical
href: https://signaldb.js.org/reference/core/creatememoryadapter/
- - meta
- name: og:type
content: article
- - meta
- name: og:url
content: https://signaldb.js.org/reference/core/creatememoryadapter/
- - meta
- name: og:title
content: createMemoryAdapter | SignalDB
- - meta
- name: og:description
content: Learn how to use createMemoryAdapter in SignalDB to implement custom memory-based data storage for collections with array-like methods.
- - meta
- name: description
content: Learn how to use createMemoryAdapter in SignalDB to implement custom memory-based data storage for collections with array-like methods.
- - meta
- name: keywords
content: SignalDB, createMemoryAdapter, memory adapter, data storage, custom adapters, JavaScript, TypeScript, in-memory collections, collection management, array methods
---
# createMemoryAdapter

```js
Expand Down
Empty file removed docs/reference/core/index.md
Empty file.
24 changes: 24 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
---
head:
- - link
- rel: canonical
href: https://signaldb.js.org/reference/
- - meta
- name: og:type
content: article
- - meta
- name: og:url
content: https://signaldb.js.org/reference/
- - meta
- name: og:title
content: Reference | SignalDB
- - meta
- name: og:description
content: Explore the comprehensive reference for SignalDB, including core components, integrations, persistence adapters, and reactivity adapters to enhance your projects.
- - meta
- name: description
content: Explore the comprehensive reference for SignalDB, including core components, integrations, persistence adapters, and reactivity adapters to enhance your projects.
- - meta
- name: keywords
content: SignalDB, API reference, core components, integrations, persistence adapters, reactivity adapters, data management, JavaScript, TypeScript, SyncManager, collections, reactivity
---
# Reference

SignalDB consists of several packages of which each has indiviudal exports.
Expand Down

0 comments on commit 231d398

Please sign in to comment.