Class JournalInternal

Staticprefixed

addListener

• addListener<T extends "update" | "delete">(
      event: T,
      fn: (
          ...args: ArgumentMap<
              { delete: [path: string]; update: [op: "delete", path: string] },
          >[Extract<T, "update" | "delete">],
      ) => void,
      context?: any,
  ): this

  Type Parameters

  • T extends "update" | "delete"

  Parameters

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

  Returns this

emit

• emit<T extends "update" | "delete">(
      event: T,
      ...args: ArgumentMap<
          { delete: [path: string]; update: [op: "delete", path: string] },
      >[Extract<T, "update" | "delete">],
  ): boolean

  Calls each of the listeners registered for a given event.

  Type Parameters

  • T extends "update" | "delete"

  Parameters

  • event: T
  • ...args: ArgumentMap<{ delete: [path: string]; update: [op: "delete", path: string] }>[Extract<
        T,
        "update"
        | "delete",
    >]

  Returns boolean

eventNames

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

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

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

listenerCount

• listenerCount(event: "update" | "delete"): number

  Return the number of listeners listening to a given event.

  Parameters

  • event: "update" | "delete"

  Returns number

listeners

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

  Return the listeners registered for a given event.

  Type Parameters

  • T extends "update" | "delete"

  Parameters

  • event: T

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

off

• off<T extends "update" | "delete">(
      event: T,
      fn?: (
          ...args: ArgumentMap<
              { delete: [path: string]; update: [op: "delete", path: string] },
          >[Extract<T, "update" | "delete">],
      ) => void,
      context?: any,
      once?: boolean,
  ): this

  Type Parameters

  • T extends "update" | "delete"

  Parameters

  • event: T
  • Optionalfn: (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "update" | "delete">],
    ) => void
  • Optionalcontext: any
  • Optionalonce: boolean

  Returns this

on

• on<T extends "update" | "delete">(
      event: T,
      fn: (
          ...args: ArgumentMap<
              { delete: [path: string]; update: [op: "delete", path: string] },
          >[Extract<T, "update" | "delete">],
      ) => void,
      context?: any,
  ): this

  Add a listener for a given event.

  Type Parameters

  • T extends "update" | "delete"

  Parameters

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

  Returns this

once

• once<T extends "update" | "delete">(
      event: T,
      fn: (
          ...args: ArgumentMap<
              { delete: [path: string]; update: [op: "delete", path: string] },
          >[Extract<T, "update" | "delete">],
      ) => void,
      context?: any,
  ): this

  Add a one-time listener for a given event.

  Type Parameters

  • T extends "update" | "delete"

  Parameters

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

  Returns this

removeAllListeners

• removeAllListeners(event?: "update" | "delete"): this

  Remove all listeners, or those of the specified event.

  Parameters

  • Optionalevent: "update" | "delete"

  Returns this

removeListener

• removeListener<T extends "update" | "delete">(
      event: T,
      fn?: (
          ...args: ArgumentMap<
              { delete: [path: string]; update: [op: "delete", path: string] },
          >[Extract<T, "update" | "delete">],
      ) => void,
      context?: any,
      once?: boolean,
  ): this

  Remove the listeners of a given event.

  Type Parameters

  • T extends "update" | "delete"

  Parameters

  • event: T
  • Optionalfn: (
        ...args: ArgumentMap<
            { delete: [path: string]; update: [op: "delete", path: string] },
        >[Extract<T, "update" | "delete">],
    ) => void
  • Optionalcontext: any
  • Optionalonce: boolean

  Returns this