Class DocumentManager

Represents an interface to a y-sweet document management endpoint.

Index

Constructors

Properties

Methods

checkStore createDoc doFetch getClientToken getOrCreateDocAndToken

Constructors

constructor

new DocumentManager(connectionString): DocumentManager
Create a new DocumentManager.
Parameters
- connectionString: string
Returns DocumentManager
- Defined in src/main.ts:138

Properties

`Private` baseUrl

baseUrl: string

The base URL of the remote document manager API.

`Private` `Optional` token

token?: string

A string that grants the bearer access to the document management API.

Methods

checkStore

checkStore(): Promise<CheckStoreResult>
Returns Promise<CheckStoreResult>
- Defined in src/main.ts:227

createDoc

createDoc(docId?): Promise<DocCreationResult>
Creates a new document on the y-sweet server given an optional docId. If a document with given ID already exists, this is a no-op.
Parameters
- Optional docId: string
  The ID of the document to be created. If not provided, a random ID will be generated.
Returns Promise<DocCreationResult>
A DocCreationResult object containing the ID of the created document.
- Defined in src/main.ts:238

`Private` doFetch

doFetch(url, method): Promise<Response>
Internal helper for making an authorized fetch request to the API.
Parameters
- url: string
- method: "GET"
Returns Promise<Response>
- Defined in src/main.ts:163
doFetch(url, method, body): Promise<Response>
Internal helper for making an authorized fetch request to the API.
Parameters
- url: string
- method: "POST"
- body: Record<string, any>
Returns Promise<Response>
- Defined in src/main.ts:164

getClientToken

getClientToken(docId): Promise<ClientToken>
Get a client token for the given document.

If you are using authorization, this is expected to be called from your server after a user has authenticated. The returned token should then be passed to the client.
Parameters
- docId: string | DocCreationResult
  The ID of the document to get a token for.
Returns Promise<ClientToken>
A ClientToken object containing the URL and token needed to connect to the document.
- Defined in src/main.ts:258

getOrCreateDocAndToken

getOrCreateDocAndToken(docId?): Promise<ClientToken>
A convenience wrapper around DocumentManager.createDoc and DocumentManager.getClientToken for getting a client token for a document. If a docId is provided, ensures that a document exists with that ID or that one is created. If no docId is provided, a new document is created with a random ID.
Parameters
- Optional docId: string
  The ID of the document to get or create. If not provided, a new document with a random ID will be created.
Returns Promise<ClientToken>
A ClientToken object containing the URL and token needed to connect to the document.
- Defined in src/main.ts:279