Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

AssociatedCollectionItem

AssociatedCollectionItem<T2, T>: { item: CollectionItem<T>; key: T2 }

Type parameters

  • T2

  • T

Type declaration

AssociatedSearchItem

AssociatedSearchItem: { item: any; key: any }

Type associating search items with a key.

Type declaration

  • item: any
  • key: any

ChunkCallback

ChunkCallback<T>: (items: Collection<T>) => any

Type parameters

  • T

Type declaration

CollectionComparable

CollectionComparable<T>: CollectionItem<T>[] | Collection<T>

Type parameters

  • T

CollectionFunction

CollectionFunction<T, T2>: (items: Collection<T>) => T2

Type parameters

  • T

  • T2

Type declaration

CollectionIndex

CollectionIndex: number

CollectionItem

CollectionItem<T>: T

Type parameters

  • T

ComparisonFunction

ComparisonFunction<T>: (item: CollectionItem<T>, other_item: CollectionItem<T>) => number

Type parameters

  • T

Type declaration

ComplexSubscriber

ComplexSubscriber<T>: { complete?: SubscriberCompleteFunction<T>; error?: SubscriberErrorFunction; next?: SubscriberFunction<T> }

Subscribers that define multiple handler methods.

Type parameters

  • T

Type declaration

Constructor

Constructor<T>: new (...args: any[]) => T

Base type for a constructor function.

Type parameters

  • T = {}

Type declaration

    • new (...args: any[]): T
    • Parameters

      • Rest ...args: any[]

      Returns T

DeterminesEquality

DeterminesEquality<T>: (item: CollectionItem<T>, other: any) => boolean

Type parameters

  • T

Type declaration

GlobalRegistrant

GlobalRegistrant: { key: string | symbol; value: any }

Type structure for a single item in the global registry.

Type declaration

  • key: string | symbol
  • value: any

JSONState

JSONState: {}

Type representing a JSON serializable object.

Type declaration

  • [key: string]: string | boolean | number | undefined | JSONState | (string | boolean | number | undefined | JSONState)[]

KeyFunction

KeyFunction<T, T2>: (item: CollectionItem<T>, index: number) => CollectionItem<T2>

Type parameters

  • T

  • T2

Type declaration

KeyOperator

KeyOperator<T, T2>: string | KeyFunction<T, T2>

Type parameters

  • T

  • T2

KeyReducerFunction

KeyReducerFunction<T, T2>: (current: any, item: CollectionItem<T>, index: number) => T2

Type parameters

  • T

  • T2

Type declaration

MaybeCollectionIndex

MaybeCollectionIndex: CollectionIndex | undefined

MaybeCollectionItem

MaybeCollectionItem<T>: CollectionItem<T> | undefined

Type parameters

  • T

MaybeIterationItem

MaybeIterationItem<T>: { done: boolean; value?: T }

Type parameters

  • T

Type declaration

  • done: boolean
  • Optional value?: T

PathLike

PathLike: string | UniversalPath

An item that could represent a path.

PipeOperator

PipeOperator<T, T2>: (subject: T) => T2

A closure that maps a given pipe item to a different type.

Type parameters

  • T

  • T2

Type declaration

    • (subject: T): T2
    • Parameters

      • subject: T

      Returns T2

ReflexivePipeOperator

ReflexivePipeOperator<T>: (subject: T) => T

A closure that maps a given pipe item to an item of the same type.

Type parameters

  • T

Type declaration

    • (subject: T): T
    • Parameters

      • subject: T

      Returns T

SubscriberCompleteFunction

SubscriberCompleteFunction<T>: (val?: T) => any

Type of a basic subscriber function that handles completed events.

Type parameters

  • T

Type declaration

    • (val?: T): any
    • Parameters

      • Optional val: T

      Returns any

SubscriberErrorFunction

SubscriberErrorFunction: (error: Error) => any

Type of a basic subscriber function that handles errors.

Type declaration

    • (error: Error): any
    • Parameters

      • error: Error

      Returns any

SubscriberFunction

SubscriberFunction<T>: (val: T) => any

Type of a basic subscriber function.

Type parameters

  • T

Type declaration

    • (val: T): any
    • Parameters

      • val: T

      Returns any

Subscription

Subscription<T>: SubscriberFunction<T> | ComplexSubscriber<T>

Subscription to a behavior subject.

Type parameters

  • T

Unsubscribe

Unsubscribe: { unsubscribe: () => void }

Object providing helpers for unsubscribing from a subscription.

Type declaration

  • unsubscribe: () => void
      • (): void
      • Returns void

WhereOperator

WhereOperator: "&" | ">" | ">=" | "<" | "<=" | "!=" | "<=>" | "%" | "|" | "!" | "~" | "=" | "^"

Type representing a valid where operator.

WhereResult

WhereResult: any[]

Type representing the result of a where.

Variables

Const HTTPMessage

HTTPMessage: { 100: string; 101: string; 102: string; 200: string; 201: string; 202: string; 203: string; 204: string; 205: string; 206: string; 207: string; 300: string; 301: string; 302: string; 303: string; 304: string; 305: string; 307: string; 308: string; 400: string; 401: string; 402: string; 403: string; 404: string; 405: string; 406: string; 407: string; 408: string; 409: string; 410: string; 411: string; 412: string; 413: string; 414: string; 415: string; 416: string; 417: string; 418: string; 419: string; 420: string; 422: string; 423: string; 424: string; 428: string; 429: string; 431: string; 500: string; 501: string; 502: string; 503: string; 504: string; 505: string; 507: string; 511: string } = ...

Maps HTTP status code to default status message.

Type declaration

  • 100: string
  • 101: string
  • 102: string
  • 200: string
  • 201: string
  • 202: string
  • 203: string
  • 204: string
  • 205: string
  • 206: string
  • 207: string
  • 300: string
  • 301: string
  • 302: string
  • 303: string
  • 304: string
  • 305: string
  • 307: string
  • 308: string
  • 400: string
  • 401: string
  • 402: string
  • 403: string
  • 404: string
  • 405: string
  • 406: string
  • 407: string
  • 408: string
  • 409: string
  • 410: string
  • 411: string
  • 412: string
  • 413: string
  • 414: string
  • 415: string
  • 416: string
  • 417: string
  • 418: string
  • 419: string
  • 420: string
  • 422: string
  • 423: string
  • 424: string
  • 428: string
  • 429: string
  • 431: string
  • 500: string
  • 501: string
  • 502: string
  • 503: string
  • 504: string
  • 505: string
  • 507: string
  • 511: string

Const globalRegistry

globalRegistry: GlobalRegistry = ...

Export a singleton global registry for all code to share.

Exporting an instance here guarantees that all code that import it will get the same instance.

Functions

applyMixins

  • applyMixins(derivedCtor: any, baseCtors: any[]): void

Const applyWhere

Const collect

deepCopy

  • deepCopy<T>(target: T): T

error

infer

  • infer(val: string): any

isJSON

  • isJSON(val: string): boolean

isJSONState

Const isLogMessage

  • isLogMessage(something: any): something is LogMessage

Const isLoggingLevel

many

message

one

padCenter

  • padCenter(string: string, length: number, padWith?: string): string
  • If string is less than length characters long, add however many padWith characters are necessary to make up the difference evenly split between the beginning and end of the string.

    Parameters

    • string: string
    • length: number
    • padWith: string = ' '

    Returns string

padLeft

  • padLeft(string: string, length: number, padWith?: string): string
  • If string is less than length characters long, add however many padWith characters are necessary to make up the difference to the BEGINNING of the string.

    Parameters

    • string: string
    • length: number
    • padWith: string = ' '

    Returns string

padRight

  • padRight(string: string, length: number, padWith?: string): string
  • If string is less than length characters long, add however many padWith characters are necessary to make up the difference to the END of the string.

    Parameters

    • string: string
    • length: number
    • padWith: string = ' '

    Returns string

uninfer

  • uninfer(val: any): string

universalPath

uuid_v4

  • uuid_v4(): string

walk

  • walk(dir: string): any
  • Walk recursively over entries in a directory.

    Right now the types are kinda weird for async iterables. This is like an async IterableIterable that resolves a string or another IterableIterable of the same type.

    Hence why it's separate from the UniversalPath class.

    Parameters

    • dir: string

    Returns any

Const whereMatch

withTimeout

Extollo Logo

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.