Call Signature

function format(obj?): any;

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

Parameters

Parameter	Type
obj?	any

Returns

any

Example

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'

Call Signature

function format(obj, options): string;

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

Parameters

Parameter	Type
obj	any
options	DateTimeFormatOptions & { calendar?: string; timeZone?: string; }

Returns

string

Example

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'

Call Signature

function format(
   obj, 
   fmt, 
   options?): bigint;

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

Parameters

Parameter	Type
obj	any
fmt	"{nano}"
options?	any

Returns

bigint

Example

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'

Call Signature

function format(
   obj, 
   fmt, 
   options?): number;

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

Parameters

Parameter	Type
obj	any
fmt	| "{yw}{wy}" | "{yyyy}{mm}" | "{ymd}" | "{yyyy}{wy}" | "{yyyy}{mm}{dd}" | "{yywy}" | "{yw}" | "{ymd6}" | "{hms}" | "{ff}" | "{dmy}" | "{dmy6}" | "{mdy}" | "{mdy6}"
options?	any

Returns

number

Example

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'

Call Signature

function format(
   obj, 
   fmt, 
   options?): string;

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

Parameters

Parameter	Type
obj	any
fmt	string | symbol
options?	any

Returns

string

Example

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'