openDocumentAsync
openDocumentAsync<
DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey,RootStateType>(documentId,selectPeerborneState?,initialization?):ThunkAction<Promise<PeerborneDocument<DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey> |null>,RootStateType,unknown,CloseDocumentAction|OpenDocumentAction<DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey> |SyncDocumentAction<DocType>>
Defined in: packages/redux/src/actions.ts:190
Type Parameters
Section titled “Type Parameters”DocType
Section titled “DocType”DocType
ChangesType
Section titled “ChangesType”ChangesType
ChangeFnType
Section titled “ChangeFnType”ChangeFnType
PrivateKey
Section titled “PrivateKey”PrivateKey
PublicKey
Section titled “PublicKey”PublicKey
DocumentKey
Section titled “DocumentKey”DocumentKey
RootStateType
Section titled “RootStateType”RootStateType = PeerborneState<DocType, ChangesType, ChangeFnType, PrivateKey, PublicKey, DocumentKey>
Parameters
Section titled “Parameters”documentId
Section titled “documentId”string
selectPeerborneState?
Section titled “selectPeerborneState?”(rootState) => PeerborneState<DocType, ChangesType, ChangeFnType, PrivateKey, PublicKey, DocumentKey>
initialization?
Section titled “initialization?”"open" | "create"
Returns
Section titled “Returns”ThunkAction<Promise<PeerborneDocument<DocType, ChangesType, ChangeFnType, PrivateKey, PublicKey, DocumentKey> | null>, RootStateType, unknown, CloseDocumentAction | OpenDocumentAction<DocType, ChangesType, ChangeFnType, PrivateKey, PublicKey, DocumentKey> | SyncDocumentAction<DocType>>