Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Journal<T>

Journal class for error handling, extending built-in Array class.

Type parameters

  • T: JournalEntry

Hierarchy

  • Array<T>
    • Journal

Index

Constructors

constructor

  • new Journal<T>(length: number): Journal<T>
  • new Journal<T>(...items: T[]): Journal<T>
  • Constructs an instance of Journal with the given length.

    Type parameters

    • T: JournalEntry

    Parameters

    • length: number

    Returns Journal<T>

  • Constructs an instance of Journal; typical usage will not pass options, and if options are passed they will be validated.

    Type parameters

    • T: JournalEntry

    Parameters

    • Rest ...items: T[]

    Returns Journal<T>

Properties

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Readonly Static [Symbol.species]

[Symbol.species]: ArrayConstructor

Accessors

critical

  • get critical(): T[]

errors

  • get errors(): T[]

hasError

  • get hasError(): boolean

info

  • get info(): T[]

maxLevel

  • get maxLevel(): "info" | "warn" | "error" | "crit"
  • Get the highest level of journal entry in this journal.

    Returns "info" | "warn" | "error" | "crit"

warnings

  • get warnings(): T[]

Methods

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<T>
  • Iterator

    Returns IterableIterator<T>

[Symbol.unscopables]

  • [Symbol.unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

concat

  • concat(...items: ConcatArray<T>[]): T[]
  • concat(...items: (T | ConcatArray<T>)[]): T[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<T>[]

      Additional items to add to the end of array1.

    Returns T[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns T[]

copyWithin

  • copyWithin(target: number, start: number, end?: number): Journal<T>
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns Journal<T>

entries

  • entries(): IterableIterator<[number, T]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, T]>

every

  • every<S>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any): this is S[]
  • every(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Type parameters

    • S: JournalEntry

    Parameters

    • predicate: (value: T, index: number, array: T[]) => value is S

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        • (value: T, index: number, array: T[]): value is S
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns value is S

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns this is S[]

  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • predicate: (value: T, index: number, array: T[]) => unknown

      A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

        • (value: T, index: number, array: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: T, start?: number, end?: number): Journal<T>
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: T

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns Journal<T>

filter

  • filter<S>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any): S[]
  • filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): T[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: JournalEntry

    Parameters

    • predicate: (value: T, index: number, array: T[]) => value is S

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

        • (value: T, index: number, array: T[]): value is S
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns value is S

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • predicate: (value: T, index: number, array: T[]) => unknown

      A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

        • (value: T, index: number, array: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns T[]

find

  • find<S>(predicate: (value: T, index: number, obj: T[]) => value is S, thisArg?: any): S
  • find(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: JournalEntry

    Parameters

    • predicate: (value: T, index: number, obj: T[]) => value is S

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (value: T, index: number, obj: T[]): value is S
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns value is S

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S

  • Parameters

    • predicate: (value: T, index: number, obj: T[]) => unknown
        • (value: T, index: number, obj: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns unknown

    • Optional thisArg: any

    Returns T

findIndex

  • findIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: (value: T, index: number, obj: T[]) => unknown

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: T, index: number, obj: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns unknown

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

flat

  • flat<A, D>(depth?: D): FlatArray<A, D>[]
  • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

    Type parameters

    • A

    • D: number = 1

    Parameters

    • Optional depth: D

      The maximum recursion depth

    Returns FlatArray<A, D>[]

flatMap

  • flatMap<U, This>(callback: (value: T, index: number, array: T[]) => U | readonly U[], thisArg?: This): U[]
  • Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

    Type parameters

    • U

    • This = undefined

    Parameters

    • callback: (value: T, index: number, array: T[]) => U | readonly U[]

      A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

        • (value: T, index: number, array: T[]): U | readonly U[]
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns U | readonly U[]

    • Optional thisArg: This

      An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

forEach

  • forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: (value: T, index: number, array: T[]) => void

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): void
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

getCritical

  • getCritical(op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"): T[]
  • Get critical errors by operation name.

    Parameters

    • op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"

    Returns T[]

getEntries

  • getEntries(op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read" | "all", ...level: ("info" | "warn" | "error" | "crit")[]): T[]
  • Get all journal entries matching an operation and optionally a certain level.

    Parameters

    • op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read" | "all"
    • Rest ...level: ("info" | "warn" | "error" | "crit")[]

    Returns T[]

getErrors

  • getErrors(op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"): T[]
  • Get errors, including critical, by operation name.

    Parameters

    • op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"

    Returns T[]

getInfo

  • getInfo(op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"): T[]
  • Get information by operation name.

    Parameters

    • op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"

    Returns T[]

getWarnings

  • getWarnings(op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"): T[]
  • Get warnings by operation name.

    Parameters

    • op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"

    Returns T[]

includes

  • includes(searchElement: T, fromIndex?: number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: T

      The element to search for.

    • Optional fromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: T, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: T, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: (value: T, index: number, array: T[]) => U

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): U
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): T
  • Removes the last element from an array and returns it.

    Returns T

push

  • push(...entries: T[]): number
  • Only valid journal entries will be added to the array; invalid entries will be dropped. If no entry id is provided, it will be added.

    Parameters

    • Rest ...entries: T[]

    Returns number

reduce

  • reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T): T
  • reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T): T
  • reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    Returns T

  • Parameters

    • callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    • initialValue: T

    Returns T

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: T, currentIndex: number, array: T[]): U
        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T): T
  • reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T): T
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    Returns T

  • Parameters

    • callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T
        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    • initialValue: T

    Returns T

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: T, currentIndex: number, array: T[]): U
        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): T[]
  • Reverses the elements in an Array.

    Returns T[]

shift

  • shift(): T
  • Removes the first element from an array and returns it.

    Returns T

slice

  • slice(start?: number, end?: number): T[]
  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns T[]

some

  • some(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • predicate: (value: T, index: number, array: T[]) => unknown

      A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

        • (value: T, index: number, array: T[]): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

      An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: (a: T, b: T) => number): Journal<T>
  • Sorts an array.

    Parameters

    • Optional compareFn: (a: T, b: T) => number

      Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      [11,2,22,1].sort((a, b) => a - b)
      
        • (a: T, b: T): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns Journal<T>

splice

  • splice(start: number, deleteCount?: number): T[]
  • splice(start: number, deleteCount: number, ...items: T[]): T[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: number

      The number of elements to remove.

    Returns T[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: T[]

      Elements to insert into the array in place of the deleted elements.

    Returns T[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: T[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: T[]

      Elements to insert at the start of the Array.

    Returns number

Private validate

  • validate(data: any): data is T

values

  • values(): IterableIterator<T>
  • Returns an iterable of values in the array

    Returns IterableIterator<T>

Static from

  • from<T>(arrayLike: ArrayLike<T>): T[]
  • from<T, U>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[]
  • from<T>(iterable: Iterable<T> | ArrayLike<T>): T[]
  • from<T, U>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[]
  • Creates an array from an array-like object.

    Type parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like object to convert to an array.

    Returns T[]

  • Creates an array from an iterable object.

    Type parameters

    • T

    • U

    Parameters

    • arrayLike: ArrayLike<T>

      An array-like object to convert to an array.

    • mapfn: (v: T, k: number) => U

      A mapping function to call on every element of the array.

        • (v: T, k: number): U
        • Parameters

          • v: T
          • k: number

          Returns U

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns U[]

  • Creates an array from an iterable object.

    Type parameters

    • T

    Parameters

    • iterable: Iterable<T> | ArrayLike<T>

      An iterable object to convert to an array.

    Returns T[]

  • Creates an array from an iterable object.

    Type parameters

    • T

    • U

    Parameters

    • iterable: Iterable<T> | ArrayLike<T>

      An iterable object to convert to an array.

    • mapfn: (v: T, k: number) => U

      A mapping function to call on every element of the array.

        • (v: T, k: number): U
        • Parameters

          • v: T
          • k: number

          Returns U

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns U[]

Static isArray

  • isArray(arg: any): arg is any[]
  • Parameters

    • arg: any

    Returns arg is any[]

Static of

  • of<T>(...items: T[]): T[]
  • Returns a new array from a set of elements.

    Type parameters

    • T

    Parameters

    • Rest ...items: T[]

      A set of elements to include in the new array object.

    Returns T[]

Generated using TypeDoc