Options
All
  • Public
  • Public/Protected
  • All
Menu

@toreda/types - v2.13.1

Index

Type aliases Alias

Type aliases Collections

Type aliases Expressive Types

Type aliases Expressive Types - Cryptocurrencies

Type aliases Expressive Types - Data Types

Type aliases Expressive Types - Data Units

Type aliases Expressive Types - Data-rate Units

Type aliases Expressive Types - Imperial Units

Type aliases Expressive Types - Units of Measurement (Metric)

Type aliases Expressive Types - Units of Measurement (Scientific)

Type aliases Lifecycle

Type aliases Network Connections

Type aliases Object API

Type aliases Runnable

Type aliases Signatures

Type aliases Type Guards

Type aliases Type Mapping

Interfaces Base

Interfaces Closeable

Interfaces Collections

Interfaces Data

Interfaces Lifecycle

Interfaces Object API

Interfaces Runnable

Interfaces Type Mapping

Classes Lifecycle

Classes Runnable

Variables Lifecycle

Functions Lifecycle

Alias Type aliases

ANY: any

Alias for 'any'. Toreda types avoid 'any' whenever possible. Accurate types, generics, or even unknown are always preferred. In rare cases where 'any' is necessary, this alias avoids compiler warnings and demonstrates 'any' usage is intentional.

Collections Type aliases

ArrayFunc<T, U>: (element: T, ndx: number, arr: T[]) => U

Type parameters

  • T

  • U

Type declaration

    • (element: T, ndx: number, arr: T[]): U
    • Array callback type signature used by forEach.

      Parameters

      • element: T
      • ndx: number
      • arr: T[]

      Returns U

Expressive Types Type aliases

AnyFunc<T>: (...args: ANY[]) => T

Type parameters

  • T = unknown

Type declaration

    • (...args: ANY[]): T
    • Alias for basic sync or async functions.

      Parameters

      • Rest ...args: ANY[]

      Returns T

AnyObj<T>: Record<string, T>

Type alias for simple objects.

Type parameters

  • T = unknown

Data: Record<string, string | boolean | null | number | unknown[]>

Describes dictionary objects mapping strings to primitive data.

Expand<T>: T extends infer obj ? { [ key in keyof obj]: obj[key] } : never

Type parameters

  • T

HashAlg: string

Unique identifier for a specific hashing algorithm. Commonly used to identify which algorithm was used when more than one option is available.

HashStr: string

Expressive type for strings produced by hashing algorithms.

Optional<InterfaceT, ExceptKey>: Omit<InterfaceT, ExceptKey> & Partial<InterfaceT>

Make all top-level InterfaceT properties optional except the key name or key names provided in ExceptKey.

Type parameters

  • InterfaceT

  • ExceptKey: keyof InterfaceT

PrivateKey: string

Identifies private key data. Does not describe data, data length, or algorithm used. Only identifies that data is a public key. Additional fields may further describe details about key.

PublicKey: string

Identifies public key data. Does not describe data, data length, or algorithm used. Only identifies that data is a public key. Additional fields may further describe details about key.

Tag: string

String value used in semantic tagging in one or more systems.

Expressive Types - Cryptocurrencies Type aliases

AAVE: string

Expressive Alias for values expressing quantities of AAVE tokens.

ALGO: string

Expressive Alias for values expressing quantities of Algorand tokens.

ATOM: string

Expressive Alias for values expressing quantities of Cosmos Hub Coins.

AVAX: string

Expressive Alias for values expressing quantities of Avalanche Coins.

AXS: string

Expressive Alias for values expressing quantities of Axie Infinity tokens.

AdaAddr: string | number

Expressive Alias for ADA Addresses.

AdaTokenAmt: string

Expressive Alias for values expressing ADA Token quantities.

ApeAddr: string | number

Expressive Alias for APE Wallet Addresses.

ApeCoinAmt: string

Expressive Alias for values expressing APE Coin quantities.

AvaxAddr: string | number

Expressive Alias for AVAX Addresses.

AvaxTokenAmt: string

Expressive Alias for values expressing AVAX Token quantities.

BAT: string

Expressive Alias for values expressing quantities of Basic Attention Tokens.

BCN: string

Expressive Alias for values expressing quantities of BCN Coins.

BTM: string

Expressive Alias for values expressing quantities of BTM Coins.

BTT: string

Expressive Alias for values expressing quantities of BitTorrent Coins.

BUSD: string

Expressive Alias for values expressing quantities of Binance USD Coins.

BchAddr: string | number

Expressive Alias for Bch Addresses.

BchTokenAmt: string

Expressive Alias for values expressing BCH Token quantities.

BnbAddr: string | number

Expressive Alias for BNB wallet addresses.

BnbTokenAmt: string

Expressive Alias for values expressing quantities of BNB Coins.

BscAddr: string | number

Expressive Alias for BSC Wallet Addresses.

BtcAddr: string | number

Expressive Alias for APE Wallet Addresses.

BtcCoinAmt: string

Expressive Alias for values expressing APE Coin quantities.

CAKE: string

Expressive Alias for values expressing quantities of PancakeSwap Tokens.

CDAI: string

Expressive Alias for values expressing quantities of cDAI Coins.

CELO: string

Expressive Alias for values expressing quantities of CELO tokens.

CUSDC: string

Expressive Alias for values expressing quantities of CUSDC.

CoinAmt: string

Expressive Alias for values expressing coin quantities.

Coins: string

Expressive Alias for values expressing quantities of cryptocurrency coins.

DAI: string

Expressive Alias for values expressing quantities of DAI Stablecoins.

DASH: string

Expressive Alias for values expressing quantities of DASH Coins.

DGB: string

Expressive Alias for values expressing quantities of Digibyte Coins.

DOT: string

Expressive Alias for values expressing quantities of Polkadot Coins.

DogeAddr: string | number

Expressive Alias for TRX wallet addresses.

DogeTokenAmt: string

Expressive Alias for values expressing quantities of DOGE tokens.

ENJ: string

Expressive Alias for values expressing quantities of Enjin Coins.

EOS: string

Expressive Alias for values expressing quantities of EOS Coins.

EthAddr: string | number

Expressive Alias for ETH wallet addresses.

EthTokenAmt: string

Expressive Alias for values expressing quantities of ETH tokens.

FIL: string

Expressive Alias for values expressing quantities of Filecoins.

FLO: string

Expressive Alias for values expressing quantities of FLO Coins.

FLOW: string

Expressive Alias for values expressing quantities of FLOW tokens.

FTM: string

Expressive Alias for values expressing quantities of Fantom Coins.

FTT: string

Expressive Alias for values expressing quantities of FTX Tokens.

GRT: string

Expressive Alias for values expressing quantities of TheGraph Coins.

GalaAddr: string | number

Expressive Alias for Gala wallet addresses.

GalaTokenAmt: string

Expressive Alias for values expressing quantities of Gala tokens.

HBAR: string

Expressive Alias for values expressing quantities of Hedera Hashgraph tokens.

Hashrate: string

Expressive Alias for values expressing quantities of Hashrate (Cryptocurrency / coins).

ICP: string

Expressive Alias for values expressing quantities of Internet Computer tokens.

KSM: string

Expressive Alias for values expressing quantities of Kusama Coins.

LRC: string

Expressive Alias for values expressing quantities of Loopring tokens.

LTC: string

Expressive Alias for values expressing quantities of Litecoins.

LUNA: string

Expressive Alias for values expressing quantities of Terra Coins.

LinkAddr: string | number

Expressive Alias for LINK Addresses.

LinkTokenAmt: string

Expressive Alias for values expressing LINK Token quantities.

MANA: string

Expressive Alias for values expressing quantities of Decentraland tokens.

MKR: string

Expressive Alias for values expressing quantities of MakerDAO tokens.

MaticAddr: string | number

Expressive Alias for MATIC addresses.

MaticTokenAmt: string

Expressive Alias for values expressing MATIC Token quantities.

NearAddr: string | number

Expressive Alias for NEAR Addresses.

NearTokenAmt: string

Expressive Alias for values expressing NEAR Token quantities.

NexoAddr: string | number

Expressive Alias for NEXO addresses.

NexoTokenAmt: string

Expressive Alias for values expressing NEXO Token quantities.

RvnAddr: string | number

Expressive Alias for RVN addresses.

RvnTokenAmt: string

Expressive Alias for values expressing RVN Token quantities.

SAND: string

Expressive Alias for values expressing quantities of The Sandbox tokens.

STX: string

Expressive Alias for values expressing quantities of Stacks tokens.

SYS: string

Expressive Alias for values expressing quantities of SYS Coins.

ShibAddr: string | number

Expressive Alias for SHIB addresses.

ShibTokenAmt: string

Expressive Alias for values expressing SHIB Token quantities.

SolAddr: string | number

Expressive Alias for SOL wallet addresses.

SolTokenAmt: string

Expressive Alias for values expressing SOL Token quantities.

THETA: string

Expressive Alias for values expressing quantities of Theta Network tokens.

TUSD: string

Expressive Alias for values expressing quantities of TrueUSD Coins.

TokenAmt: string

Expressive Alias for values expressing token quantities.

TokenSymbol: string

Expressive Alias for expressing Token Symbols.

Tokens: string

Expressive Alias for values expressing quantities of cryptocurrency tokens.

TrxAddr: string | number

Expressive Alias for TRX addresses.

TrxTokenAmt: string

Expressive Alias for values expressing TRX Token quantities.

UNI: string

Expressive Alias for values expressing quantities of Uniswap tokens.

USDC: string

Expressive Alias for values expressing quantities of USDC Coins.

USDT: string

Expressive Alias for values expressing quantities of USDT Coins.

VET: string

Expressive Alias for values expressing quantities of VET Coins.

WBTC: string

Expressive Alias for values expressing quantities of Wrapped Bitcoins.

WETH: string

Expressive Alias for values expressing quantities of Wrapped Ethereum tokens.

WavesAddr: string

Expressive Alias for Waves addresses.

WavesTokenAmt: string

Expressive Alias for values expressing Waves token quantities.

XRD: string

Expressive Alias for values expressing quantities of Radix tokens.

XTZ: string

Expressive Alias for values expressing quantities of Tezos tokens.

XVG: string

Expressive Alias for values expressing quantities of Verge Coins.

XlmAddr: string

Expressive Alias for XLM addresses.

XlmTokenAmt: string

Expressive Alias for values expressing XLM token quantities.

XmrAddr: string | number

Expressive Alias for XMR Addresses.

XmrTokenAmt: string

Expressive Alias for values expressing XMR Token quantities.

XrpAddr: string | number

Expressive Alias for XRP Addresses.

XrpTokenAmt: string

Expressive Alias for values expressing XRP Token quantities.

ZecAddr: string | number

Expressive Alias for ZEC Addresses.

ZecTokenAmt: string

Expressive Alias for values expressing ZEC Token quantities.

ZilAddr: string | number

Expressive Alias for ZIL Addresses.

ZilTokenAmt: string

Expressive Alias for values expressing ZIL Token quantities.

Expressive Types - Data Types Type aliases

BitField: number

Expressive type for BitField numbers storing multiple single bit flags in one numeric value.

BitMask: number

Expressive type for numbers used as BitMask values. Alias only. No functional changes applied to value or type.

FileSize: number

Numeric file sizes, typically represented in bytes.

Expressive Types - Data Units Type aliases

Bits: number

Expressive Alias for data values expressed in Bits.

Bytes: number

Alias for data values expressed in Bytes.

Exabytes: number

Expressive Alias for data values expressed in Exabytes.

Gigabytes: number

Expressive Alias for data values expressed in Gigabytes.

KB: number

Expressive Alias for data values expressed in abbreviated Kilobytes (KB).

Kilobits: number

Expressive Alias for values expressed in Kilobits.

Kilobytes: number

Expressive Alias for values expressed in Kilobytes.

Megabytes: number

Expressive Alias for data values expressed in Megabytes.

TB: number

Expressive Alias for data values expressed in abbreviated Terabytes.

Terabits: number

Expressive Alias for values expressed in Terabits.

Terabytes: number

Expressive Alias for values expressed in Terabytes.

Expressive Types - Data-rate Units Type aliases

Bps: number

Alias for data-rate values expressed in abbreviated bytes per second.

GBps: number

Expressive Alias for data-rate values expressed in gigabytes per second.

Gbps: number

Expressive Alias for data-rate values expressed in gigabits per second.

KBps: number

Expressive Alias for data-rate units values in kilobytes per second.

Kbps: number

Expressive Alias for data-rate values expressed in kilobits per second.

MBps: number

Expressive Alias for data-rate values expressed in Megabytes per second.

Mbps: number

Expressive Alias for data-rate values expressed in Megabits per second.

PBps: number

Expressive Alias for data-rate values expressed in Petabytes per second.

Pbps: number

Expressive Alias for data-rate values expressed in Petabits per second.

TBps: number

Expressive Alias for data-rate values expressed in Terabytes per second.

Tbps: number

Expressive Alias for data-rate values expressed in Terabits per second.

bps: number

Alias for data-rate values expressed in abbreviated bits per second.

Expressive Types - Imperial Units Type aliases

Feet: number

Expressive Alias for values expressed in Feet (Imperial).

FluidOunces: number

Expressive Alias for values expressed in Fluid Ounces (Imperial).

Gallons: number

Expressive Alias for values expressed in Gallons (Imperial).

Grams: number

Expressive Alias for values expressed in Grams (Imperial).

Inches: number

Expressive Alias for values expressed in Inches (Imperial).

Miles: number

Expressive Alias for distance values expressed in Miles (Imperial).

Ounces: number

Expressive Alias for values expressed in Ounces (Imperial).

RSI: number

Expressive Alias for values expressed in RSI (Imperial).

Yards: number

Expressive Alias for values expressed in Yards (Imperial).

Expressive Types - Units of Measurement (Metric) Type aliases

Centimeters: number

Expressive Alias for values expressed in Centimeters (Metric).

Decimeters: number

Expressive Alias for metric units expressed in Decimeters (Metric).

Femtometers: number

Expressive Alias for values expressed in Femtometers.

Gigameters: number

Expressive Alias for metric units expressed in Gigameters (Metric).

Kilometers: number

Expressive Alias for values expressed in Kilometers (Metric).

Liters: number

Expressive Alias for values expressed in Liters.

Megameters: number

Expressive Alias for metric units expressed in Megameters (Metric).

Meters: number

Expressive Alias for values expressed in Meters (Metric).

Micrometers: number

Expressive Alias for metric units expressed in Micrometers (Metric).

Millimeters: number

Expressive Alias for values expressed in Millimeters (Metric).

Nanometers: number

Expressive Alias for metric units expressed in Nanometers (Metric).

Picometers: number

Expressive Alias for values expressed in Picometers (Metric).

Terameters: number

Expressive Alias for metric units expressed in Terameters (Metric).

Expressive Types - Units of Measurement (Scientific) Type aliases

Degrees: number

Expressive Alias for rotational values expressed in Degrees.

Farads: number

Expressive Alias for values expressing electrical capacitance.

Hertz: number

Expressive Alias for measurement values expressing frequency in Hertz.

Katals: number

Expressive Alias for values expressing catalytic activity.

Kelvin: number

Expressive Alias for scientific data values expressed in Kelvin.

Kilograms: number

Expressive Alias for values expressing units of electric capacitance in Ohms.

Lumens: number

Expressive Alias for values expressing units of luminous flux.

Newtons: number

Expressive Alias for scientific values expressing force & weight in Newtons.

Ohms: number

Expressive Alias for values expressing units of electric capacitance in Ohms.

Pascals: number

Expressive Alias for scientific data values expressing units of pressure in Pascals.

Radians: number

Expressive Alias for angle and rotational values expressed as Radians.

Sieverts: number

Expressive Alias for values expressing dose equivalent, ambient dose equivalent, directional dose equivalent, personal dose equivalent, organ dose equivalent.

Watts: number

Expressive Alias for values expressing power or radiant flux in Watts.

Lifecycle Type aliases

LifecycleClientPhase: "didBecomeReady" | "didGainFocus" | "didInit" | "didLoad" | "didLoseFocus" | "didStart" | "didUnpause" | "memoryWarning" | "onInit" | "onLoad" | "onReady" | "onStart" | "willBecomeReady" | "willGainFocus" | "willInit" | "willLoad" | "willLoseFocus" | "willPause" | "willStart" | "willStop"

Expressive type describing phase names used in client lifecycle flow.

LifecycleListener: () => Promise<boolean> | boolean

Type declaration

    • (): Promise<boolean> | boolean
    • Signature for listener functions executed in response to lifecycle events.

      Returns Promise<boolean> | boolean

LifecycleNetworkCnxPhase: "cnxWillStartConnect" | "cnxDidStartConnect" | "cnxWillStopConnect" | "cnxDidStopConnect" | "cnxDidFailConnect" | "cnxDidConnect" | "cnxWillOpen" | "cnxDidOpen" | "cnxWillClose" | "cnxDidClose" | "cnxWillConnect" | "cnxWillDisconnect" | "cnxDidDisconnect" | "cnxOnPing" | "cnxOnPong"

Expressive type describing phase names used in client lifecycle flow.

LifecyclePhaseId: string

Used for arguments specifying a target lifecycle phase.

LifecycleServerPhase: "didBecomeReady" | "didInit" | "didLoad" | "didStop" | "didStart" | "willBecomeReady" | "willInit" | "willLoad" | "willShutdown" | "willStart" | "willStop"

Type describing phase names used in server lifecycle flow.

Network Connections Type aliases

NetworkCnxId: string

Expressive alias for unique identifiers for Network Connections.

Object API Type aliases

Arrayable<T>: T | T[]

Type of a single object of type T or array of type T objects.

Type parameters

  • T

Awaited<T>: T extends PromiseLike<infer U> ? U : T

Type parameters

  • T = unknown

DeepExpand<T>: T extends Primitive ? T : T extends infer obj ? { [ key in keyof obj]: DeepExpand<obj[key]> } : never

Type parameters

  • T

DeepPartial<T>: Expand<{ [ key in keyof T]?: T[key] extends Primitive ? T[key] : DeepPartial<T[key]> }>

Recursively change properties to optional on the returned type. Partial marks top-level type T properties optional, but does not recursively mark children of T or children of children, and so on.

Type parameters

  • T

DeepRequired<T>: Expand<{ [ key in keyof T]-?: T[key] extends Primitive ? NonNullable<T[key]> : DeepRequired<T[key]> }>

Type parameters

  • T

Depromisify<T>: T extends Promise<infer U> ? U : T

Type parameters

  • T

Nullable<T>: T | null

Type parameters

  • T = unknown

Primitive: bigint | boolean | null | number | string | symbol | undefined

Type union with all TypeScript / JavaScript primitive types.

Promisable<T>: T | Promise<T>

Type parameters

  • T = unknown

Visitor<NodeT>: (node: NodeT) => Promise<NodeT | null>

Type parameters

  • NodeT

Type declaration

    • (node: NodeT): Promise<NodeT | null>
    • Parameters

      • node: NodeT

      Returns Promise<NodeT | null>

Runnable Type aliases

RunnableTask<ArgDataT, ReturnT>: (data: ArgDataT) => Promise<ReturnT>

Type parameters

  • ArgDataT

  • ReturnT

Type declaration

    • (data: ArgDataT): Promise<ReturnT>
    • Asynchronous task function signature for functions invoked by Runnable class instances.

      Parameters

      • data: ArgDataT

      Returns Promise<ReturnT>

RunnableTaskSync<ArgDataT, ReturnT>: (data: ArgDataT) => ReturnT

Type parameters

  • ArgDataT

  • ReturnT

Type declaration

    • (data: ArgDataT): ReturnT
    • Synchronous task function signature for functions invoked by Runnable class instances. Use non-synchronous task functions when possible, as long synchronous calls on the main/UI thread block the event Loop.

      Parameters

      • data: ArgDataT

      Returns ReturnT

Signatures Type aliases

Constructor<T>: {}

Type signature for objects with a unique class constructor. Used in runtime type matching and identification.

Type parameters

  • T = unknown

Type declaration

    NullOrUndefined<T>: T | null | undefined

    Type parameters

    • T = unknown

    PrimitiveOrConstructor: {} | keyof TypeMap

    Type signature for primitives or objects with unique constructors used in run-time type matching and identification.

    Type Guards Type aliases

    Guarded<T>: T extends {} ? U : T extends keyof TypeMap ? TypeMap[T] : never

    Infer guarded type using a Primitive or Constructor.

    Typeguard implementation by Ran Lottem https://dev.to/krumpet/generic-type-guard-in-typescript-258l

    Type parameters

    Type Mapping Type aliases

    LiteralToPrimitive<SubOption>: SubOption extends boolean ? boolean : SubOption extends number ? number : SubOption extends string ? string : SubOption

    Map literal value to matching primitive.

    Type parameters

    • SubOption

    Lifecycle Variables

    lifecycleClientPhases: Set<LifecycleClientPhase> = ...
    lifecycleServerPhases: Set<LifecycleServerPhase> = ...

    Lifecycle Functions

    • lifecyclePhaseListenerName(id: string): string | null
    • Get listener name for target Lifecycle Phase.

      Parameters

      • id: string

        Target Phase ID to return listener name for.

      Returns string | null

      Listener Name string when id is a valid phase id. null when id doesn't match a supported phase, or is not a string.

    Generated using TypeDoc