Orb

Documentation

Time and formatting

Every operator a .lolo program can call, from the canonical registry the compiler bakes.

On this page

Namespaces on this page: format/, time/.

format/

`format/bytes`

Format bytes as human-readable size

lolo

(format/bytes n)

Parameters

Name	Type	Description
`n`	`number`	Bytes

Returns: string

Example

lolo

(format/bytes 2500000) // => "2.4 MB"

`format/creditCard`

Format credit card with masked digits

lolo

(format/creditCard str)

Parameters

Name	Type	Description
`str`	`string`	Card number

Returns: string

Example

lolo

(format/creditCard "4111111111111234") // => "•••• •••• •••• 1234"

`format/currency`

Format as currency

lolo

(format/currency n currency locale)

Parameters

Name	Type	Description
`n`	`number`	Amount
`currency`	`string`	Currency code (USD, EUR, etc.)
`locale`	`string`	Locale

Returns: string

Example

lolo

(format/currency 1234.56 "USD") // => "$1,234.56"

`format/list`

Format array as natural language list

lolo

(format/list arr style)

Parameters

Name	Type	Description
`arr`	`array`	Array of strings
`style`	`string`	"and" or "or"

Returns: string

Example

lolo

(format/list (Alice "Bob" "Charlie") "and") // => "Alice, Bob, and Charlie"

`format/number`

Format number with locale-aware separators

lolo

(format/number n opts)

Parameters

Name	Type	Description
`n`	`number`	Number to format
`opts`	`object`	Format options (decimals, locale)

Returns: string

Example

lolo

(format/number 1234567.89) // => "1,234,567.89"

`format/ordinal`

Format number as ordinal (1st, 2nd, 3rd)

lolo

(format/ordinal n)

Parameters

Name	Type	Description
`n`	`number`	Number

Returns: string

Example

lolo

(format/ordinal 42) // => "42nd"

`format/percent`

Format as percentage

lolo

(format/percent n decimals)

Parameters

Name	Type	Description
`n`	`number`	Number (0.5 = 50%)
`decimals`	`number`	Decimal places

Returns: string

Example

lolo

(format/percent 0.856 1) // => "85.6%"

`format/phone`

Format phone number

lolo

(format/phone str format)

Parameters

Name	Type	Description
`str`	`string`	Phone number digits
`format`	`string`	Format pattern

Returns: string

Example

lolo

(format/phone "5551234567") // => "(555) 123-4567"

`format/plural`

Format count with singular/plural word

lolo

(format/plural n singular plural)

Parameters

Name	Type	Description
`n`	`number`	Count
`singular`	`string`	Singular form
`plural`	`string`	Plural form

Returns: string

Example

lolo

(format/plural 5 "item" "items") // => "5 items"

time/

`time/add`

Add time to timestamp

lolo

(time/add date amount unit)

Parameters

Name	Type	Description
`date`	`number`	Timestamp
`amount`	`number`	Amount to add
`unit`	`string`	Time unit (year/month/week/day/hour/minute/second/ms)

Returns: number

Example

lolo

(time/add (time/now) 7 "day")

`time/day`

Get day of month from timestamp (1-31)

lolo

(time/day date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: number

Example

lolo

(time/day 1700000000000) // => 14

`time/diff`

Difference between timestamps

lolo

(time/diff a b unit)

Parameters

Name	Type	Description
`a`	`number`	First timestamp
`b`	`number`	Second timestamp
`unit`	`string`	Result unit

Returns: number

Example

lolo

(time/diff 1700000000000 ["time/now"] "year")

`time/duration`

Format milliseconds as duration ("2h 30m")

lolo

(time/duration ms)

Parameters

Name	Type	Description
`ms`	`number`	Duration in milliseconds

Returns: string

Example

lolo

(time/duration 9000000) // => "2h 30m"

`time/endOf`

Get end of time period

lolo

(time/endOf date unit)

Parameters

Name	Type	Description
`date`	`number`	Timestamp
`unit`	`string`	Time unit

Returns: number

Example

lolo

(time/endOf (time/now) "month")

`time/format`

Format timestamp to string

lolo

(time/format date format)

Parameters

Name	Type	Description
`date`	`number`	Timestamp
`format`	`string`	Format pattern

Returns: string

Example

lolo

(time/format 1700000000000 "MMM DD, YYYY")

`time/hour`

Get hour from timestamp (0-23)

lolo

(time/hour date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: number

Example

lolo

(time/hour 1700000000000)

`time/isAfter`

Check if a is after b

lolo

(time/isAfter a b)

Parameters

Name	Type	Description
`a`	`number`	First timestamp
`b`	`number`	Second timestamp

Returns: boolean

Example

lolo

(time/isAfter ["time/now"] 1700000000000)

`time/isBefore`

Check if a is before b

lolo

(time/isBefore a b)

Parameters

Name	Type	Description
`a`	`number`	First timestamp
`b`	`number`	Second timestamp

Returns: boolean

Example

lolo

(time/isBefore 1700000000000 1700086400000)

`time/isBetween`

Check if date is between start and end

lolo

(time/isBetween date start end)

Parameters

Name	Type	Description
`date`	`number`	Timestamp to check
`start`	`number`	Range start
`end`	`number`	Range end

Returns: boolean

Example

lolo

(time/isBetween ["time/now"] 1700000000000 2000000000000)

`time/isFuture`

Check if timestamp is in the future

lolo

(time/isFuture date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: boolean

Example

lolo

(time/isFuture 2000000000000)

`time/isPast`

Check if timestamp is in the past

lolo

(time/isPast date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: boolean

Example

lolo

(time/isPast 1700000000000)

`time/isSame`

Check if timestamps are same (optionally by unit)

lolo

(time/isSame a b unit)

Parameters

Name	Type	Description
`a`	`number`	First timestamp
`b`	`number`	Second timestamp
`unit`	`string`	Comparison unit

Returns: boolean

Example

lolo

(time/isSame 1700000000000 1700001000000 "day")

`time/isToday`

Check if timestamp is today

lolo

(time/isToday date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: boolean

Example

lolo

(time/isToday ["time/now"])

`time/minute`

Get minute from timestamp (0-59)

lolo

(time/minute date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: number

Example

lolo

(time/minute 1700000000000)

`time/month`

Get month from timestamp (1-12)

lolo

(time/month date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: number

Example

lolo

(time/month 1700000000000) // => 11

`time/now`

Current timestamp

lolo

(time/now)

Returns: number

Example

lolo

(time/now) // => 1705593600000

`time/parse`

Parse string to timestamp

lolo

(time/parse str format)

Parameters

Name	Type	Description
`str`	`string`	Date string
`format`	`string`	Format pattern

Returns: number

Example

lolo

(time/parse "2024-01-18" "YYYY-MM-DD")

`time/relative`

Format as relative time ("2 hours ago", "in 3 days")

lolo

(time/relative date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: string

Example

lolo

(time/relative 1700000000000) // => "2 hours ago"

`time/second`

Get second from timestamp (0-59)

lolo

(time/second date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: number

Example

lolo

(time/second 1700000000000)

`time/startOf`

Get start of time period

lolo

(time/startOf date unit)

Parameters

Name	Type	Description
`date`	`number`	Timestamp
`unit`	`string`	Time unit (year/month/week/day/hour/minute)

Returns: number

Example

lolo

(time/startOf (time/now) "month")

`time/subtract`

Subtract time from timestamp

lolo

(time/subtract date amount unit)

Parameters

Name	Type	Description
`date`	`number`	Timestamp
`amount`	`number`	Amount to subtract
`unit`	`string`	Time unit

Returns: number

Example

lolo

(time/subtract (time/now) 1 "hour")

`time/today`

Today at midnight (local time)

lolo

(time/today)

Returns: number

Example

lolo

(time/today)

`time/weekday`

Get day of week (0=Sunday, 6=Saturday)

lolo

(time/weekday date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: number

Example

lolo

(time/weekday 1700000000000) // => 2 (Tuesday)

`time/year`

Get year from timestamp

lolo

(time/year date)

Parameters

Name	Type	Description
`date`	`number`	Timestamp

Returns: number

Example

lolo

(time/year 1700000000000) // => 2023

Data

Validation

Orb

The language where the rule is the program.

Learn

Get started Docs Blog

Tools

Playground Standard library Explore Play Downloads Studio

Community

GitHub Discord Almadar