Classes

AdapterBuilder<K, V>AdapterError abstract AdapterWrapper<K, V>AsyncMutex CacheAdapter<K, V>CatalogLockManager Catalog ChunkLockManager ChunkManager CompressionAdapter<K, V>ConnectionError CuckooFilter DataCorruptionError EncryptionAdapter<K, V>Env<T>FeatureNotSupportedError Field<Type, Optional, Custom>FileAdapter<K, V>FlashcoreError FlashcoreModel<T>FlashcoreSchemaError IndexPersistenceManager IntegrityChecker JunctionTableManager KeyvAdapter<V>LegacyFileAdapter<K, V>Logger MemoryAdapter<K, V>MigrationError MigrationLockManager MigrationRegistry MigrationRunner NotFoundError PluginManager QueryPlanner RecordValidator RelationField RepairEngine ResilienceAdapter<K, V>SafeKeyEncoder SafetyError SchemaHistoryManager SchemaMetadataManager SerialTransactionQueue SortedIndex State StorageExhaustedError TransactionConflictError TransactionContext TypeSerializer UniqueConstraintError UniqueIndexManager ValidationError WriteAheadLog

Interfaces

AdapterCapabilitiesReport AdapterCapabilities AdapterTransaction<K, V>AggregatedMetadata ApiEntry Api AutoRepairConfig AvailableIndexes BaseConfig BatchResult BatchedIncludeResult BuildCompleteContext BuildContext BuildStore BuildTransformContext CacheOptions CacheStats CascadeContext CascadeOp CatalogData CatalogDeleteDelta CatalogEntry CatalogRebuildOptions CatalogRebuildProgress CatalogRebuildResult CatalogSetDelta CatalogSetSegmentsDelta CatalogVerificationResult ChangeAnalysisResult ChunkDeleteDelta ChunkPatchDelta ChunkPutDelta ChunkStats CliCommandConfig CliCommandEntry CliCommandModule CliContext<C>CliExtendConfig CliExtendModule CliExtensionEntry CliManifest CliOptionConfig CompoundUniqueConstraint CompressionOptions Config CountArgs<T>CreateArgs CreateManyArgs<T>CuckooFilterData CuckooFilterOptions DeleteArgs<T>DeleteManyArgs<T>DeltaBuildResult DiscoveredRoute DrainHandle EncodedKeyData EncryptionOptions EntriesAccessor EnvMetadata EnvPattern EnvVariableStatus EpochData ErrorContext EventConfig Event ExportsConfig FieldDef FieldDiffEntry FieldMetadata FieldQueryResolver FileAdapterOptions FileDrainOptions FileOutputConfig FilterAddDelta FilterIntegrityResult FilterRemoveDelta FindFirstArgs<T>FindManyArgs<T>FindUniqueArgs<T>FlashcoreAdapter<K, V>FlashcoreConfig FlashcoreGetOptions FlashcoreIntrospection FlashcoreKVOptions FlashcoreMetrics FlashcoreModelOptions FlashcorePluginDefinition<TClientExtensions, TModelExtensions, TState>FlashcorePlugin FlashcoreSchema FlushResult FullRepairResult HandlerEntry HandlerModule<THandler, TNamedExports>HandlerRecord<THandler, TNamedExports>HmrContext HmrEventContext HmrEventRouteInfo HmrHandlerInfo HmrHookConfig HmrReloadHandlerPayload HmrReloadRoutePayload HmrRouteInfo HmrSubscribeOptions HmrSubscription HMR HookContext<T>HookEntry HotModule ITransactionContext IncludeContext IncludeOptions IndexIntegrityResult IndexOptions IndexPersistenceOptions IndexProvider<T>IndexRemoveDelta IndexUpsertDelta InitContext InitOptions IntegrityCheckOptions IntegrityCheckProgress IntegrityReport IpcEmitOptions IpcEvent IpcState JSONPatch JunctionTableDef KeyConfig KeyvAdapterOptions KeyvLike<V>LegacyFileAdapterOptions LoadedCliCommand LoadedCliExtension LockAcquisitionResult LockStatus LoggerOptions ManifestAPI ManifestConfigMap ManifestHookMap ManifestMetadataMap ManifestOptions ManifestRouteMap ManifestSeedEnv ManifestSeed ManyToManyConnect MetadataIndex MigrationContext MigrationDefinition MigrationLockOptions MigrationLock MigrationMetadata MigrationModelAccessor<T>MigrationResult MigrationRunOptions MigrationRunnerOptions MigrationStatusReport ModelDiff ModelHooks<T>ModelInfo ModelOptions ModelQueryResolver ModelTransactionContext ModuleController ModuleState NamespaceRouteDefinitions NestingConfig NormalizedField NormalizedSchema OperationParams<Op>OrderByInput PackageJson ParsedIncludeEntry PluginContext PluginCountArgs PluginCreateManyArgs PluginData PluginDeleteArgs PluginDeleteManyArgs PluginFindUniqueArgs PluginInfo PluginManifestInfo PluginMetaOptions PluginMiddleware PluginSetupContext<TState>PluginState PluginUpdateArgs PluginUpdateManyArgs PluginUpsertArgs PortalAPI PortalNamespaceConfig PortalNamespaces PortalRouteConfig PrepareContext<TConfig>ProcessedEntry ProjectMetadata PromptQuestion QueryArgs QueryContext QueryPlan RangeOptions ReadSetEntry RecoveryContext RecoveryResult RegisteredMigration RelationDef RelationFieldValue RelationInfo RelationMetadata RelationValidationError RepairOptions RepairProgress RepairResult ResilienceOptions RoboMessage RoboReply RoboRequest RoboStateMessage RouteConfig RouteDefinitionConfig RouteDefinition RouteEntries ScannedEntry SchemaChange SchemaField SchemaHistoryEntry SchemaMetadata SchemaSnapshot SchemaValidationError ScopedPortal SeedConfig SeedEnvConfig SeedEnvVariableConfig SeedHookConfig SeedHookGenerators SeedHookHelpers SegmentDeleteDelta SegmentPutDelta SegmentWrite SerialQueueItem SetupContext SortedIndexData SpiritMessage StartContext<TConfig>StopContext<TConfig>TransactionContextState TransactionExecutionOptions TransactionOptions TransactionResult<T>UniqueAcquireDelta UniqueChange UniqueConstraintOptions UniqueIndexEntry UniqueIntegrityResult UniqueReleaseDelta UniqueUpdate UpdateArgs<T>UpdateManyArgs<T>UpsertArgs<T>ValidationResult VersionDiff WALConfig WALEntryHeader WALEntry WalSegmentInfo WhereInput

Type Aliases

BatchOperation<K, V>ChunkData CliAfterHook()CliBeforeHook()CliHandler()CliOptionTypeMap CliOptionsFromConfig<C>ControllerFactory()<T>CreateInput<T>CreateScopedPortal()DisposeCallback()ExtractOptionName<N>FieldType FlashcoreClient HmrCallback()HooksManifest HttpMethod IncludeClause InferFieldType<T, Custom>InferModelType<S>LifecycleHookType LogDrain()LogLevel ManifestSeedEnvVariables MetadataAggregatorRegistry MetadataAggregator()<T>MiddlewareFn()<Op>MigrationStatus OnDeleteAction OperationArgs<Op>OperationResult<Op>OperationType OrderBy<T>OrderDirection PluginRegistry Plugin QueryOperatorFn()RelationType ResolvedTransactionMode RouteDefinitions RouteHandler()RouteType SchemaChangeType SchemaFields SeedHookHandler()SeedsIndex SelectClause<T>SmartCliCommandConfig<C>StagedOperation TimestampFormat TransactionCommitHandler()TransactionMode UniqueWhere<T>UpdateInput<T>ValueOfCliOption<O>WalAuthoritativeDelta WalDerivedDelta WALEntryInput WalInverseDelta WalOp WalPhase WatcherCallback()<V>WhereClause<T>WhereOperators<T>WithClientExtensions<TClient, TPlugins>WithPluginExtensions<TModel, TPlugins>

Functions

acquireUniqueConstraints()analyzeNamespaceChanges()analyzeSchemaChanges()applyCatalogDeleteDelta()applyCatalogSetDelta()applyCatalogSetSegmentsDelta()applyDefaults()applyModelExtensions()applyPatch()applyPatches()buildAdapter()buildCreateDeltas()buildCreateSegmentedDeltas()buildDeleteDeltas()buildDeleteSegmentedDeltas()buildIndexKey()buildModelKey()buildPluginKey()buildSchemaHistoryKey()buildSchemaKey()buildTransactionOptions()buildUniqueKey()buildUpdateChunkToSegmentsDeltas()buildUpdateDeltas()buildUpdateSegmentedDeltas()buildUpdateSegmentsToChunkDeltas()buildWalEntryKey()buildWalSegmentKey()calculateRetryDelay()checkRestrictConstraints()clearSerialQueue()collectCascadeOperations()compareChecksums()composeColors()composeLegacyKey()composeMiddleware()composeV1Key()compoundUnique()computePatch()computePatches()computeSchemaChecksum()consoleDrain()createBoundContext()createCacheAdapter()createChunkManager()createCliCommandConfig()createClientExtensions()createCompressionAdapter()createConditionalMiddleware()createEncryptionAdapter()createErrorHandlerMiddleware()createFileAdapter()createFileDrain()createFullTextIndex()createJunctionSchema()createKeyvAdapterFromOptions()createKeyvAdapter()createLegacyFileAdapter()createLevelFilteredDrain()createLoggingMiddleware()createMemoryAdapter()createMigrationRunner()createModel()createMultiDrain()createPluginManager()createPluginState()createResilienceAdapter()createSimpleIndex()createTrieIndex()createValidationMiddleware()decodeKey()decodeUniqueValue()defineIndex()defineMigration()definePlugin()delay()emit()encodeKey()encodeUniqueValue()evaluatePluginWhere()evaluateWhere()executeAfterCreate()executeAfterDelete()executeAfterUpdate()executeBeforeCreate()executeBeforeDelete()executeBeforeUpdate()executeCascadeOperations()executeIndexPlan()executeWithMiddleware()extractTimestamp()filterMightContain()forModels()forOperations()formatSchemaChanges()formatTimestamp()generateId()generateMigrationContent()generateMigrationFilename()generateRandomId()getConfig()getIndexPersistenceManager()getJunctionModelName()getJunctionTableDef()getMissingRequiredFields()getModeName()getPluginContext()getPluginManager()getPluginNames()getPluginOptions()getSerialQueue()getState()getUnknownFields()getWALManager()hasAcidSupport()hasIncludes()hasPlugin()hasScanCapability()hasSchemaChanged()inferNamespace()isCapable()isJunctionModel()isReservedPrefix()isSerializedBigInt()isSerializedDate()isValidId()isWALEnabled()logger()mergeHooks()metadataToNormalizedField()needsEncoding()normalizeCapabilities()normalizeNamespace()normalizeRecordShape()normalizeSchema()normalizedFieldToMetadata()parseJunctionModelName()parseLegacyKey()prioritizeHookAfter()prioritizeHookBefore()rebuildCatalogFromChunks()recoverWAL()registerEnvPattern()releaseUniqueConstraints()replayEntryWithContext()requireCapability()requiresAcid()requiresVersionTracking()resolveAutoMode()resolveInclude()resolveIncludesBatched()rollbackEntryWithContext()scanKeysToArray()scanKeys()setHookPriority()setIndexPersistenceManager()setPluginManager()setState()setWALManager()sortRecords()summarizeChanges()throwIfInvalid()validateForeignKey()validateForeignKeys()validateHooks()validateMode()validateNotReserved()validateRelationsSchema()verifyCatalogIntegrity()warnMissingCapabilities()wrapModelWithPluginAccess()

Variables

AdapterPresets ANSI REGEX catalogLockManager CATALOG VERSION chunkLockManager color DEBUG MODE default DEFAULT AUTO REPAIR CONFIG DEFAULT CONNECTION SETTINGS DEFAULT HOOK PRIORITY DEFAULT INDEX PERSISTENCE SETTINGS DEFAULT MAX CHUNK SIZE DEFAULT MAX RECORDS PER CHUNK DEFAULT NAMESPACE SEPARATOR DEFAULT ON DELETE DEFAULT SAFETY CONFIG DEFAULT SAFETY LIMITS DEFAULT TRANSACTION SETTINGS ENCODED KEY PREFIX env f FlashcoreSystem Flashcore fullTextIndexProvider hmr ID CONSTRAINTS Ipc JUNCTION PREFIX LEGACY KEY SEPARATOR Manifest MAX CASCADE DEPTH MAX INCLUDE DEPTH MAX LENGTHS MAX SCHEMA HISTORY ENTRIES MAX VERSION VALUE migrationRegistry MIGRATION LOCK KEY MIGRATION LOCK TIMEOUT MS MIGRATION STATUS PREFIX MIGRATION TEMPLATE Mode portal RESERVED PREFIXES Robo safeKeyEncoder SAFE ID PATTERN SAFE KEY CHARS SCHEMA META SUFFIX trieIndexProvider VERSION FIELD NAME VERSION OVERFLOW WARN THRESHOLD WAL CLOCK SKEW TOLERANCE MS WAL DEFAULT SEGMENT SIZE WAL ENTRY KEY PREFIX WAL ENTRY PREFIX WAL SEGMENT PREFIX WAL STALE THRESHOLD MS

Framework

safeKeyEncoder

Variable: safeKeyEncoder

const safeKeyEncoder: SafeKeyEncoder;

Default encoder instance.

Robo

Previous

SAFE ID PATTERN

Next

Resources

Documentation
Blog
Templates

Ecosystem

Plugins
RoboPlay
npm

Community

Discord
GitHub
Twitter

© 2026 WavePlay, LLC. All rights reserved.

On this page

Variable: safeKeyEncoder