Skip to content

Call Signature

ts
function format(obj?): any;

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

Parameters

ParameterType
obj?any

Returns

any

Example

ts
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

ts
function format(obj, fmt): number;

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

Parameters

ParameterType
objany
fmt| "{yw}{ww}" | "{yyyy}{mm}" | "{yyyy}{mm}{dd}" | "{yyyy}{ww}" | "{yyww}" | "{yw}"

Returns

number

Example

ts
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

ts
function format(obj, fmt): string;

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

Parameters

ParameterType
objany
fmtstring | symbol

Returns

string

Example

ts
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'

Released under the MIT License.