api / type

NumberSignalTrap

Number trap with numeric operations and formatting methods.

Source: src/api/traps/types.ts

Number trap with numeric operations and formatting methods.

Signature

export type NumberSignalTrap = GenericTrap<number> & {
  /** Confines the number to a range. */
  toConfined: (
    start: MaybeSignalValue<number>,
    end: MaybeSignalValue<number>
  ) => DerivedSignal<number>;
  /** Converts to exponential notation string. */
  toExponential: SignalifiedFunction<number["toExponential"]>;
  /** Converts to locale-specific string. */
  toLocaleString: (
    locales?: MaybeSignalValue<string | string[] | undefined>,
    options?: Intl.NumberFormatOptions
  ) => DerivedSignal<string>;
  /** Converts to fixed-point notation string. */
  toFixed: SignalifiedFunction<number["toFixed"]>;
  /** Converts to precision notation string. */
  toPrecision: SignalifiedFunction<number["toPrecision"]>;
};

Type Parameters

  • The number type