Querylight TS Demo

serializeDocumentIndex

Serializes a full DocumentIndex state to gzipped bytes.

Back to docs search

Reference Entry

serializeDocumentIndex

API Reference · foundation · order 26

Serializes a full DocumentIndex state to gzipped bytes.

Relevant APIs

serializeDocumentIndex SerializeDocumentIndexParams

Tags

api-reference functions

serializeDocumentIndex

Serializes a full DocumentIndex state to gzipped bytes.

Declaration

function serializeDocumentIndex(__namedParameters: SerializeDocumentIndexParams): Uint8Array

Signatures

```ts function serializeDocumentIndex(__namedParameters: SerializeDocumentIndexParams): Uint8Array ``` Serializes a full [DocumentIndex](/docs/api/document-index/) state to gzipped bytes.

Parameters

- `__namedParameters: SerializeDocumentIndexParams`