period_left: Access /timeleft/period Endpoint

Description Usage Arguments Value Examples

View source: R/period_left.R

Description

This function accesses the /timeleft/period endpoint of the Christmas Countdown API. The specific period is supplied by the user as a function argument.

Usage

1

Arguments

period

"months", "weeks", "sleeps", "days", "hours", "minutes", or "seconds"

timezone

A UTC offset in string form. Defaults to NULL

Value

An integer corresponding to the amount of periods left until Christmas

Examples

1
2
period_left("days", timezone = "UTC-7")
period_left("weeks")

Sean-C-Casey/christmaswrap documentation built on Feb. 24, 2022, 12:33 a.m.