Call Signature
ts
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
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
| Parameter | Type |
|---|---|
obj | any |
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
| Parameter | Type |
|---|---|
obj | any |
fmt | string | 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'