Tempo API
    Preparing search index...

    Function format

    Formats a supported date-time value using a named format, template, or internationalization options.

    The value to format; omitted values use the current date and time.

    A registered format name or literal format template.

    Formatting and configuration overrides.

    The formatted date-time string, a format proxy when no format or options are supplied, or an empty string for invalid date-time values.

    • Standalone Formatter Returns a formatted string from a Temporal.ZonedDateTime or Tempo instance.

      Parameters

      • Optionalobj: any

      Returns any

      import { format } from '@magmacomputing/tempo/format';
      const str = format(Temporal.Now.zonedDateTimeISO(), '{yyyy}-{mm}-{dd}');

      // Proxy usage (zero or one argument)
      const weekDate = format(zdt).weekDate;
      const stamp = format().logStamp; // defaults to 'Now'

    • Standalone Formatter Returns a formatted string from a Temporal.ZonedDateTime or Tempo instance.

      Parameters

      • obj: any
      • options: FormatOptions

      Returns string

      import { format } from '@magmacomputing/tempo/format';
      const str = format(Temporal.Now.zonedDateTimeISO(), '{yyyy}-{mm}-{dd}');

      // Proxy usage (zero or one argument)
      const weekDate = format(zdt).weekDate;
      const stamp = format().logStamp; // defaults to 'Now'

    • Standalone Formatter Returns a formatted string from a Temporal.ZonedDateTime or Tempo instance.

      Parameters

      • obj: any
      • fmt: string | symbol
      • Optionaloptions: any

      Returns string

      import { format } from '@magmacomputing/tempo/format';
      const str = format(Temporal.Now.zonedDateTimeISO(), '{yyyy}-{mm}-{dd}');

      // Proxy usage (zero or one argument)
      const weekDate = format(zdt).weekDate;
      const stamp = format().logStamp; // defaults to 'Now'

    Settings
    Member Visibility