Class BazaarContext

constructor

• new BazaarContext(options, onConnect, onConnectError): BazaarContext

• Parameters

  • options: APIOptions
  • onConnect: (() => Promise<void>)
    • • (): Promise<void>

      • Returns Promise<void>

  • onConnectError: ((message) => Promise<void>)
    • • (message): Promise<void>

      • Parameters

        • message: string

        Returns Promise<void>

  Returns BazaarContext

collections

permissions

collection

• collection<T>(collectionName, collectionOptions?): CollectionAPI<T>

• Gets a collection interface (API access to the specified collection)

  Type Parameters

  • T extends Doc

  Parameters

  • collectionName: string

    The name of the collection to create the interface for.
  • Optional collectionOptions: CollectionOptions

    An optional object for specifying an onCreate hook. The onCreate hook sets up a collection when it is created (e.g., to set up permissions)

  Returns CollectionAPI<T>