Function defineRecorderKit

makeRecorderKit is suitable for making a durable RecorderKit which can be held in Exo state.

See

  • defineRecorderKit(makers): (<T>(storageNode: StorageNode | DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>, valueShape?: TypedPattern<T>) => RecorderKit<T>)

  • Parameters

    • makers: {
          makeDurablePublishKit: (<T>(options?: {
              valueDurability: undefined | "mandatory";
          }) => PublishKit<T>);
          makeRecorder: ((...args: [publisher: Publisher<unknown>, storageNode: DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>, valueShape: TypedPattern<any>]) => Guarded<{
              getStorageNode(): DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>;
              getStoragePath(): Promise<string>;
              write(value: any): Promise<void>;
              writeFinal(value: any): Promise<void>;
          }>);
      }
      • makeDurablePublishKit: (<T>(options?: {
            valueDurability: undefined | "mandatory";
        }) => PublishKit<T>)
          • <T>(options?): PublishKit<T>

          • Type Parameters

            • T

            Parameters

            • Optionaloptions: {
                  valueDurability: undefined | "mandatory";
              }
              • valueDurability: undefined | "mandatory"

            Returns PublishKit<T>

      • makeRecorder: ((...args: [publisher: Publisher<unknown>, storageNode: DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>, valueShape: TypedPattern<any>]) => Guarded<{
            getStorageNode(): DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>;
            getStoragePath(): Promise<string>;
            write(value: any): Promise<void>;
            writeFinal(value: any): Promise<void>;
        }>)
          • (...args): Guarded<{
                getStorageNode(): DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>;
                getStoragePath(): Promise<string>;
                write(value: any): Promise<void>;
                writeFinal(value: any): Promise<void>;
            }>

          • Parameters

            • Rest...args: [publisher: Publisher<unknown>, storageNode: DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>, valueShape: TypedPattern<any>]

            Returns Guarded<{
                getStorageNode(): DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>;
                getStoragePath(): Promise<string>;
                write(value: any): Promise<void>;
                writeFinal(value: any): Promise<void>;
            }>

    Returns (<T>(storageNode: StorageNode | DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>, valueShape?: TypedPattern<T>) => RecorderKit<T>)

      • <T>(storageNode, valueShape?): RecorderKit<T>

      • Type Parameters

        • T

        Parameters

        • storageNode: StorageNode | DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>
        • OptionalvalueShape: TypedPattern<T>

        Returns RecorderKit<T>

Settings

Member Visibility