Class Journal`Internal`

Tracks various operations for the CoW backend

Hierarchy

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

Index

Constructors

constructor

new Journal(): Journal
Returns Journal
Inherited from EventEmitter<{ update: [op: JournalOperation, path: string]; delete: [path: string]; }>.constructor

Properties

`Protected`entries

entries: JournalEntry[] = []

`Static`prefixed

prefixed: string | boolean

Methods

add

add(op: "delete", path: string): void
Parameters
- op: "delete"
- path: string
Returns void
- Defined in src/backends/cow.ts:92

addListener

addListener<T extends "delete" | "update">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "delete" | "update">],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends "delete" | "update"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          { delete: [path: string]; update: [op: "delete", path: string] },
      >[Extract<T, "delete" | "update">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

emit

emit<T extends "delete" | "update">(
    event: T,
    ...args: ArgumentMap<
        { delete: [path: string]; update: [op: "delete", path: string] },
    >[Extract<T, "delete" | "update">],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "delete" | "update"
Parameters
- event: T
- ...args: ArgumentMap<{ delete: [path: string]; update: [op: "delete", path: string] }>[Extract<
      T,
      "delete"
      | "update",
  >]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): ("delete" | "update")[]
Return an array listing the events for which the emitter has registered listeners.

Returns ("delete" | "update")[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

fromString

fromString(value: string): this
Parse a journal from a string
Parameters
- value: string
Returns this
- Defined in src/backends/cow.ts:73

has

has(op: "delete", path: string): boolean
Parameters
- op: "delete"
- path: string
Returns boolean
- Defined in src/backends/cow.ts:98

isDeleted

isDeleted(path: string): boolean
Parameters
- path: string
Returns boolean
- Defined in src/backends/cow.ts:104

listenerCount

listenerCount(event: "delete" | "update"): number
Return the number of listeners listening to a given event.
Parameters
- event: "delete" | "update"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends "delete" | "update">(
    event: T,
): (
    (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "delete" | "update">],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "delete" | "update"
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "delete" | "update">],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

off

off<T extends "delete" | "update">(
    event: T,
    fn?: (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "delete" | "update">],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends "delete" | "update"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<
          { delete: [path: string]; update: [op: "delete", path: string] },
      >[Extract<T, "delete" | "update">],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends "delete" | "update">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "delete" | "update">],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends "delete" | "update"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          { delete: [path: string]; update: [op: "delete", path: string] },
      >[Extract<T, "delete" | "update">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T extends "delete" | "update">(
    event: T,
    fn: (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "delete" | "update">],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends "delete" | "update"
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<
          { delete: [path: string]; update: [op: "delete", path: string] },
      >[Extract<T, "delete" | "update">],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: "delete" | "update"): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: "delete" | "update"
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends "delete" | "update">(
    event: T,
    fn?: (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "delete" | "update">],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends "delete" | "update"
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<
          { delete: [path: string]; update: [op: "delete", path: string] },
      >[Extract<T, "delete" | "update">],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in src/backends/cow.ts:66

Class JournalInternal

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Journal

Properties

Protectedentries

Staticprefixed

Methods

add

Parameters

Returns void

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns ("delete" | "update")[]

fromString

Parameters

Returns this

has

Parameters

Returns boolean

isDeleted

Parameters

Returns boolean

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap< { delete: [path: string]; update: [op: "delete", path: string] }, >[Extract<T, "delete" | "update">], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

toString

Returns string

Settings

On This Page

Class Journal`Internal`

`Protected`entries

`Static`prefixed

Returns (
(
...args: ArgumentMap<
{ delete: [path: string]; update: [op: "delete", path: string] },
>[Extract<T, "delete" | "update">],
) => void
)[]