Function defineRecorderKit
- defineRecorderKit(makers): (<T>(storageNode, valueShape?) => RecorderKit<T>)
Parameters
makers: {
makeDurablePublishKit: ((...args) => GuardedKit<{
publisher: {
fail(reason): void;
finish(finalValue): void;
publish(value): void;
};
subscriber: {
getUpdateSince(updateCount): any;
subscribeAfter(publishCount?): Promise<any>;
};
}>);
makeRecorder: ((...args) => Guarded<{
getStorageNode(): DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>;
getStoragePath(): Promise<string>;
write(value): Promise<void>;
writeFinal(value): Promise<void>;
}>);
}
makeDurablePublishKit: ((...args) => GuardedKit<{
publisher: {
fail(reason): void;
finish(finalValue): void;
publish(value): void;
};
subscriber: {
getUpdateSince(updateCount): any;
subscribeAfter(publishCount?): Promise<any>;
};
}>)
- (...args): GuardedKit<{
publisher: {
fail(reason): void;
finish(finalValue): void;
publish(value): void;
};
subscriber: {
getUpdateSince(updateCount): any;
subscribeAfter(publishCount?): Promise<any>;
};
}> Parameters
Rest
...args: [options: {
valueDurability: undefined | "mandatory";
}]
Returns GuardedKit<{
publisher: {
fail(reason): void;
finish(finalValue): void;
publish(value): void;
};
subscriber: {
getUpdateSince(updateCount): any;
subscribeAfter(publishCount?): Promise<any>;
};
}>
makeRecorder: ((...args) => Guarded<{
getStorageNode(): DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>;
getStoragePath(): Promise<string>;
write(value): Promise<void>;
writeFinal(value): Promise<void>;
}>)
- (...args): Guarded<{
getStorageNode(): DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>;
getStoragePath(): Promise<string>;
write(value): Promise<void>;
writeFinal(value): Promise<void>;
}> Parameters
Rest
...args: [publisher: Publisher<unknown>, storageNode: DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>, valueShape: TypedMatcher<unknown>]
Returns Guarded<{
getStorageNode(): DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>;
getStoragePath(): Promise<string>;
write(value): Promise<void>;
writeFinal(value): Promise<void>;
}>
Returns (<T>(storageNode, valueShape?) => RecorderKit<T>)
- <T>(storageNode, valueShape?): RecorderKit<T>
Parameters
storageNode: StorageNode | DataOnly<StorageNode> & RemotableBrand<DataOnly<StorageNode>, StorageNode>
makeRecorderKit
is suitable for making a durableRecorderKit
which can be held in Exo state.