Class Bundle

A bundle is a collection of documents which have been exported using exportBundle()

Index

Constructors

Accessors

Methods

Constructors

constructor

new Bundle(
docs: DocHandle<unknown>[],
args?: { since?: Map<AutomergeUrl, Automerge.Heads | UrlHeads> },
): Bundle
Parameters
- docs: DocHandle<unknown>[]
- Optionalargs: { since?: Map<AutomergeUrl, Automerge.Heads | UrlHeads> }
Returns Bundle
- Defined in index.ts:89

Accessors

data

get data(): Map<AutomergeUrl, DocBundle>
A summary of the data in this bundle

Returns Map<AutomergeUrl, DocBundle>
- Defined in index.ts:117

Methods

encode

encode(): Uint8Array
Encode this bundle into a Uint8Array

The encoding is intended to be forwards compatible

Returns Uint8Array
- Defined in index.ts:135

`Static`decode

decode(data: Uint8Array): Bundle
Attempt to decode a bundle from a Uint8Array
Parameters
- data: Uint8Array
  A Uint8Array containing a bundle encoded using ()
Returns Bundle
- Defined in index.ts:145