Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

ParamsBase<K, D>: { encoder?: ArrayEncoder; shouldInclude?: any; valueKind?: any }

Type parameters

  • K

  • D

Type declaration

  • Optional encoder?: ArrayEncoder
  • shouldInclude?:function
    • shouldInclude(data: D): boolean
    • Parameters

      • data: D

      Returns boolean

  • valueKind?:function

Functions

  • Type parameters

    • K = number

    • D = any

    • N: string = string

    Returns <internal>.Field.Builder<K, D, N>

  • float<K, D>(name: string, value: (k: K, d: D, index: number) => number, params?: ParamsBase<K, D> & { digitCount?: number; typedArray?: TypedArrayCtor }): Field<K, D>
  • Type parameters

    • K

    • D = any

    Parameters

    • name: string
    • value: (k: K, d: D, index: number) => number
        • (k: K, d: D, index: number): number
        • Parameters

          • k: K
          • d: D
          • index: number

          Returns number

    • Optional params: ParamsBase<K, D> & { digitCount?: number; typedArray?: TypedArrayCtor }

    Returns Field<K, D>

  • index(name: string): Field<unknown, any>
  • Parameters

    • name: string

    Returns Field<unknown, any>

  • Type parameters

    • K

    • D = any

    Parameters

    • name: string
    • value: (k: K, d: D, index: number) => number
        • (k: K, d: D, index: number): number
        • Parameters

          • k: K
          • d: D
          • index: number

          Returns number

    • Optional params: ParamsBase<K, D> & { typedArray?: TypedArrayCtor }

    Returns Field<K, D>

  • str<K, D>(name: string, value: (k: K, d: D, index: number) => string, params?: ParamsBase<K, D>): Field<K, D>
  • Type parameters

    • K

    • D = any

    Parameters

    • name: string
    • value: (k: K, d: D, index: number) => string
        • (k: K, d: D, index: number): string
        • Parameters

          • k: K
          • d: D
          • index: number

          Returns string

    • Optional params: ParamsBase<K, D>

    Returns Field<K, D>

Generated using TypeDoc