import { type DocWithFormat } from "https://deno.land/x/earthstar@v10.0.0-alpha.2/mod.ts";
Type Parameters
DocType extends DocBase<string>
definition: Extract<DocType, { format: FormatType; }>
Module
x/earthstar/mod.ts>DocWithFormat
Earthstar is a tool for private, undiscoverable, offline-first networks.
debugscriptssrcAttachmentDriverFilesystemAttachmentDriverMemoryConnectionRefusedErrorDocDriverLocalStorageDocDriverMemoryDocDriverSqliteEarthstarErrorLoggerNetworkErrorNotFoundErrorNotImplementedErrorPartnerLocalPartnerWebClientPartnerWebServerPeerReplicaReplicaCacheReplicaCacheIsClosedErrorReplicaDriverFsReplicaDriverMemoryReplicaIsClosedErrorSyncerTimeoutErrorValidationErrorAttachmentIngestEventAttachmentPruneEventAuthorKeypairCheckIntOptsCheckObjOptsCheckStringOptsCleanUpQueryResultDocAlreadyExistsDocBaseDocEs4DocEs5DocInputBaseDocInputEs4DocInputEs5ExpireEventFormatterGenerateOptsICryptoICryptoDriverIFormatIngestEventFailureIngestEventNothingHappenedIngestEventSuccessIPeerIReplicaAttachmentDriverIReplicaConfigIReplicaDocDriverIReplicaDriverISyncPartnerKeypairBytesQueryQueryFilterReplicaEventDidCloseReplicaEventWillCloseReplicaOptsSyncAgentHaveEventSyncerOptsAsyncCallbackAttachmentTransferOptsAttachmentTransferProgressEventAttachmentTransferReportAttachmentTransferStatusAuthorAddressAuthorShortnameBase32StringCallbackCheckerCheckerSchemaClassThatImplementsDefaultDocDefaultFormatDefaultFormatsDocAttachmentDocInputWithFormatDocWithAttachmentDocWithFormatFormatArgFormatDocTypeFormatInputTypeFormatNameFormatNameTypeFormatsArgGetTransferOptsHaveEntryHaveEntryKeeperModeHistoryModeIngestEventLocalIndexParsedAddressPathPeerIdProcessedAllExistingEventQuerySourceEventQuerySourceModeQuerySourceOptsReplicaEventReplicaIdShareAddressShareNameSignatureSortOrderSyncAgentAbortEventSyncAgentDocEventSyncAgentEventSyncAgentExhaustedHavesEventSyncAgentFulfilledEventSyncAgentHashEventSyncAgentOptsSyncAgentStatusSyncAgentWantAttachmentEventSyncAgentWantEventSyncerDiscloseEventSyncerEventSyncerFulfilledEventSyncerHeartbeatSyncerModeSyncerStatusSyncerSyncAgentEventSyncOrAsyncCallbackThunkTimestampWillMatch_matchAllalphaLoweralphaUpperauthorAddressCharsauthorKeyCharsauthorNameCharsb32charsCryptoCryptoDriverNobleCryptoDriverSodiumDEFAULT_FORMATDEFAULT_FORMATSDEFAULT_LOG_LEVELDEFAULT_QUERYdigitsextractTemplateVariablesFromPathextractTemplateVariablesFromPathUsingRegexFormatEs4FormatEs5GlobalCryptoDriverglobToQueryAndRegexglobToRegexinsertVariablesIntoTemplatepathCharspathPunctuationworkspaceAddressCharsworkspaceKeyCharsworkspaceNameCharsassembleAuthorAddressassembleShareAddressb64StringToBytesbase32BytesToStringbase32StringToBytesbytesToStringcheckAuthorIsValidcheckIntcheckIsPlainObjectcheckLiteralcheckObjcheckShareIsValidcheckStringcleanUpQuerycompareArrayscompareBasiccompareByFncompareByObjArrayFncompareByObjKeyconcatBytescountCharsdecodeAuthorKeypairToBytesdocIsExpireddocMatchesFilterencodeAuthorKeypairToStringsescapeStringForRegexgenerateShareAddressgetFormatIntersectiongetFormatLookupgetFormatsWithFallbackgetFormatWithFallbackgetLogLevelgetLogLevelsidentifyBufOrBytesisBufferisBytesisDigitisErrisObjectEmptyisOnlyPrintableAsciiisPlainObjectmicrosecondNownotErronlyHasCharsparseAddressparseAuthorAddressparseShareAddressparseTemplatequeryByGlobAsyncqueryByTemplateAsyncrandomIdreplaceAllsetDefaultLogLevelsetGlobalCryptoDriversetLogLevelsleepsortedInPlacestringLengthInBytesstringToBytessyncReplicaAndFsDirupdateLogLevelsCmpLogLeveledrfc4648sha256_uint8arrayDeferredcloneDeepdeferredshallowEqualArraysshallowEqualObjectsxxHash32AttachmentDriverIndexedDBAttachmentDriverMemoryConnectionRefusedErrorDocDriverIndexedDBDocDriverLocalStorageDocDriverMemoryEarthstarErrorLoggerNetworkErrorNotFoundErrorNotImplementedErrorPartnerLocalPartnerWebClientPeerReplicaReplicaCacheReplicaCacheIsClosedErrorReplicaDriverMemoryReplicaDriverWebReplicaIsClosedErrorSyncerTimeoutErrorValidationErrorAttachmentIngestEventAttachmentPruneEventAuthorKeypairCheckIntOptsCheckObjOptsCheckStringOptsCleanUpQueryResultDocAlreadyExistsDocBaseDocEs4DocEs5DocInputBaseDocInputEs4DocInputEs5ExpireEventFormatterGenerateOptsICryptoICryptoDriverIFormatIngestEventFailureIngestEventNothingHappenedIngestEventSuccessIPeerIReplicaAttachmentDriverIReplicaConfigIReplicaDocDriverIReplicaDriverISyncPartnerKeypairBytesQueryQueryFilterReplicaEventDidCloseReplicaEventWillCloseReplicaOptsSyncAgentHaveEventSyncerOptsAsyncCallbackAttachmentTransferOptsAttachmentTransferProgressEventAttachmentTransferReportAttachmentTransferStatusAuthorAddressAuthorShortnameBase32StringCallbackCheckerCheckerSchemaClassThatImplementsDefaultDocDefaultFormatDefaultFormatsDocAttachmentDocInputWithFormatDocWithAttachmentDocWithFormatFormatArgFormatDocTypeFormatInputTypeFormatNameFormatNameTypeFormatsArgGetTransferOptsHaveEntryHaveEntryKeeperModeHistoryModeIngestEventLocalIndexParsedAddressPathPeerIdProcessedAllExistingEventQuerySourceEventQuerySourceModeQuerySourceOptsReplicaEventReplicaIdShareAddressShareNameSignatureSortOrderSyncAgentAbortEventSyncAgentDocEventSyncAgentEventSyncAgentExhaustedHavesEventSyncAgentFulfilledEventSyncAgentHashEventSyncAgentOptsSyncAgentStatusSyncAgentWantAttachmentEventSyncAgentWantEventSyncerDiscloseEventSyncerEventSyncerFulfilledEventSyncerHeartbeatSyncerModeSyncerStatusSyncerSyncAgentEventSyncOrAsyncCallbackThunkTimestampWillMatch_matchAllalphaLoweralphaUpperauthorAddressCharsauthorKeyCharsauthorNameCharsb32charsCryptoCryptoDriverNobleDEFAULT_FORMATDEFAULT_FORMATSDEFAULT_LOG_LEVELDEFAULT_QUERYdigitsextractTemplateVariablesFromPathextractTemplateVariablesFromPathUsingRegexFormatEs4FormatEs5GlobalCryptoDriverglobToQueryAndRegexglobToRegexinsertVariablesIntoTemplatepathCharspathPunctuationworkspaceAddressCharsworkspaceKeyCharsworkspaceNameCharsassembleAuthorAddressassembleShareAddressb64StringToBytesbase32BytesToStringbase32StringToBytesbytesToStringcheckAuthorIsValidcheckIntcheckIsPlainObjectcheckLiteralcheckObjcheckShareIsValidcheckStringcleanUpQuerycompareArrayscompareBasiccompareByFncompareByObjArrayFncompareByObjKeyconcatBytescountCharsdecodeAuthorKeypairToBytesdocIsExpireddocMatchesFilterencodeAuthorKeypairToStringsescapeStringForRegexgenerateShareAddressgetFormatIntersectiongetFormatLookupgetFormatsWithFallbackgetFormatWithFallbackgetLogLevelgetLogLevelsidentifyBufOrBytesisBufferisBytesisDigitisErrisObjectEmptyisOnlyPrintableAsciiisPlainObjectmicrosecondNownotErronlyHasCharsparseAddressparseAuthorAddressparseShareAddressparseTemplatequeryByGlobAsyncqueryByTemplateAsyncrandomIdreplaceAllsetDefaultLogLevelsetGlobalCryptoDriversetLogLevelsleepsortedInPlacestringLengthInBytesstringToBytesupdateLogLevelsCmpLogLevel
mod.ts (default module)
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
E
E
deps.ts
N
N
N
I
v
f
f
f
f
mod.browser.ts
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
f
E
E