WorkspacePersistence
Nodepod API / src / WorkspacePersistence
Class: WorkspacePersistence
Section titled “Class: WorkspacePersistence”Defined in: src/persistence/workspace/controller.ts:108
Keeps a workspace saved. Available as nodepod.persistence when booted
with the persistence option. Emits saved ({ entries, bytes }) after
each successful save and error when one fails; failed saves are retried.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WorkspacePersistence(
id,volume,store,opts?,lock?):WorkspacePersistence
Defined in: src/persistence/workspace/controller.ts:134
Parameters
Section titled “Parameters”string
volume
Section titled “volume”WorkspacePersistenceOptions = {}
WorkspaceLock | null
Returns
Section titled “Returns”WorkspacePersistence
Overrides
Section titled “Overrides”EventEmitter.constructor
Properties
Section titled “Properties”_ceiling
Section titled “_ceiling”_ceiling:
number
Defined in: src/polyfills/events.ts:88
Inherited from
Section titled “Inherited from”_registry
Section titled “_registry”_registry:
Map<string,EventHandler[]>
Defined in: src/polyfills/events.ts:87
Inherited from
Section titled “Inherited from”
readonlyid:string
Defined in: src/persistence/workspace/controller.ts:109
defaultMaxListeners
Section titled “defaultMaxListeners”
staticdefaultMaxListeners:number
Defined in: src/polyfills/events.ts:111
Inherited from
Section titled “Inherited from”EventEmitter.defaultMaxListeners
EventEmitter
Section titled “EventEmitter”
staticEventEmitter:EventEmitterConstructor
Defined in: src/polyfills/events.ts:110
Inherited from
Section titled “Inherited from”EventEmitter.EventEmitter
Accessors
Section titled “Accessors”pendingChanges
Section titled “pendingChanges”Get Signature
Section titled “Get Signature”get pendingChanges():
number
Defined in: src/persistence/workspace/controller.ts:170
Paths waiting to be saved.
Returns
Section titled “Returns”number
status
Section titled “status”Get Signature
Section titled “Get Signature”get status():
PersistenceStatus
Defined in: src/persistence/workspace/controller.ts:162
Returns
Section titled “Returns”Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener(
name,handler):this
Defined in: src/polyfills/events.ts:89
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”attach()
Section titled “attach()”attach():
void
Defined in: src/persistence/workspace/controller.ts:236
Start saving changes.
Returns
Section titled “Returns”void
clear()
Section titled “clear()”clear():
Promise<void>
Defined in: src/persistence/workspace/controller.ts:267
Delete the saved workspace and stop saving. The running filesystem is left alone; boot again to start a fresh saved workspace.
Returns
Section titled “Returns”Promise<void>
close()
Section titled “close()”close():
Promise<void>
Defined in: src/persistence/workspace/controller.ts:283
Stop saving after one last save. Pending changes are captured synchronously, so the volume can be disposed right after this call.
Returns
Section titled “Returns”Promise<void>
emit()
Section titled “emit()”emit(
name, …payload):boolean
Defined in: src/polyfills/events.ts:95
Parameters
Section titled “Parameters”string
payload
Section titled “payload”…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”eventNames()
Section titled “eventNames()”eventNames():
string[]
Defined in: src/polyfills/events.ts:99
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”flush()
Section titled “flush()”flush():
Promise<void>
Defined in: src/persistence/workspace/controller.ts:257
Save pending changes now. Rejects if the save fails (it is still retried).
Returns
Section titled “Returns”Promise<void>
getMaxListeners()
Section titled “getMaxListeners()”getMaxListeners():
number
Defined in: src/polyfills/events.ts:101
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”listenerCount()
Section titled “listenerCount()”listenerCount(
name):number
Defined in: src/polyfills/events.ts:98
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”listeners()
Section titled “listeners()”listeners(
name):EventHandler[]
Defined in: src/polyfills/events.ts:96
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”load()
Section titled “load()”load():
Promise<boolean>
Defined in: src/persistence/workspace/controller.ts:179
Load the stored workspace into the (empty) volume. Resolves false when nothing (or an empty tree) was stored. Call before attach() so the restore isn’t saved straight back.
Returns
Section titled “Returns”Promise<boolean>
off(
name,handler):this
Defined in: src/polyfills/events.ts:93
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”on(
name,handler):this
Defined in: src/polyfills/events.ts:90
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once(
name,handler):this
Defined in: src/polyfills/events.ts:91
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”prependListener()
Section titled “prependListener()”prependListener(
name,handler):this
Defined in: src/polyfills/events.ts:102
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”prependOnceListener()
Section titled “prependOnceListener()”prependOnceListener(
name,handler):this
Defined in: src/polyfills/events.ts:103
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.prependOnceListener
rawListeners()
Section titled “rawListeners()”rawListeners(
name):EventHandler[]
Defined in: src/polyfills/events.ts:97
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
name?):this
Defined in: src/polyfills/events.ts:94
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
name,handler):this
Defined in: src/polyfills/events.ts:92
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”setMaxListeners()
Section titled “setMaxListeners()”setMaxListeners(
limit):this
Defined in: src/polyfills/events.ts:100
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”getEventListeners()
Section titled “getEventListeners()”
staticgetEventListeners(target,name):EventHandler[]
Defined in: src/polyfills/events.ts:115
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”EventEmitter.getEventListeners
listenerCount()
Section titled “listenerCount()”
staticlistenerCount(target,name):number
Defined in: src/polyfills/events.ts:112
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”EventEmitter.listenerCount
staticon(target,name):AsyncIterable<unknown[]>
Defined in: src/polyfills/events.ts:114
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”AsyncIterable<unknown[]>
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”
staticonce(target,name):Promise<unknown[]>
Defined in: src/polyfills/events.ts:113
Parameters
Section titled “Parameters”target
Section titled “target”string
Returns
Section titled “Returns”Promise<unknown[]>
Inherited from
Section titled “Inherited from”EventEmitter.once