Journal

Defined in: src/backends/cow.ts:62

Internal

Tracks various operations for the CoW backend

Extends

• EventEmitter<{ delete: [string]; update: [JournalOperation, string]; }>

Constructors

Constructor

new Journal(): Journal

Returns

Journal

Inherited from

EventEmitter<{ update: [op: JournalOperation, path: string]; delete: [path: string]; }>.constructor

Properties

entries

protected entries: JournalEntry[] = []

Defined in: src/backends/cow.ts:66

---

prefixed

static prefixed: string | boolean

Defined in: node_modules/eventemitter3/index.d.ts:9

Inherited from

EventEmitter.prefixed

Methods

add()

add(op, path): void

Defined in: src/backends/cow.ts:94

Parameters

op

"delete"

path

string

Returns

void

---

addListener()

addListener<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:45

Type Parameters

T

T extends "delete" | "update"

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Inherited from

EventEmitter.addListener

---

delete()

delete(op, path): void

Defined in: src/backends/cow.ts:106

Parameters

op

"delete"

path

string

Returns

void

---

emit()

emit<T>(event, …args): boolean

Defined in: node_modules/eventemitter3/index.d.ts:32

Calls each of the listeners registered for a given event.

Type Parameters

T

T extends "delete" | "update"

Parameters

event

T

args

…ArgumentMap<{ delete: [string]; update: ["delete", string]; }>[Extract<T, "delete" | "update">]

Returns

boolean

Inherited from

EventEmitter.emit

---

eventNames()

eventNames(): ("delete" | "update")[]

Defined in: node_modules/eventemitter3/index.d.ts:15

Return an array listing the events for which the emitter has registered listeners.

Returns

("delete" | "update")[]

Inherited from

EventEmitter.eventNames

---

fromString()

fromString(value): this

Defined in: src/backends/cow.ts:75

Parse a journal from a string

Parameters

value

string

Returns

this

---

has()

has(op, path): boolean

Defined in: src/backends/cow.ts:100

Parameters

op

"delete"

path

string

Returns

boolean

---

isDeleted()

isDeleted(path): boolean

Defined in: src/backends/cow.ts:110

Parameters

path

string

Returns

boolean

---

listenerCount()

listenerCount(event): number

Defined in: node_modules/eventemitter3/index.d.ts:27

Return the number of listeners listening to a given event.

Parameters

event

"delete" | "update"

Returns

number

Inherited from

EventEmitter.listenerCount

---

listeners()

listeners<T>(event): (…args) => void[]

Defined in: node_modules/eventemitter3/index.d.ts:20

Return the listeners registered for a given event.

Type Parameters

T

T extends "delete" | "update"

Parameters

event

T

Returns

(…args) => void[]

Inherited from

EventEmitter.listeners

---

off()

off<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:69

Type Parameters

T

T extends "delete" | "update"

Parameters

event

T

fn?

(…args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.off

---

on()

on<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:40

Add a listener for a given event.

Type Parameters

T

T extends "delete" | "update"

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Inherited from

EventEmitter.on

---

once()

once<T>(event, fn, context?): this

Defined in: node_modules/eventemitter3/index.d.ts:54

Add a one-time listener for a given event.

Type Parameters

T

T extends "delete" | "update"

Parameters

event

T

fn

(…args) => void

context?

any

Returns

this

Inherited from

EventEmitter.once

---

removeAllListeners()

removeAllListeners(event?): this

Defined in: node_modules/eventemitter3/index.d.ts:79

Remove all listeners, or those of the specified event.

Parameters

event?

"delete" | "update"

Returns

this

Inherited from

EventEmitter.removeAllListeners

---

removeListener()

removeListener<T>(event, fn?, context?, once?): this

Defined in: node_modules/eventemitter3/index.d.ts:63

Remove the listeners of a given event.

Type Parameters

T

T extends "delete" | "update"

Parameters

event

T

fn?

(…args) => void

context?

any

once?

boolean

Returns

this

Inherited from

EventEmitter.removeListener

---

toString()

toString(): string

Defined in: src/backends/cow.ts:68

Returns a string representation of an object.

Returns

string