This release is 1 version behind 0.9.3 — the latest version of @dnl-fm/zeit-ts. Jump to latest

@dnl-fm/zeit-ts@0.9.2
Built and signed on GitHub Actions
Built and signed on GitHub Actions

Helps syncing/reading user dates in your database

Published

2 weeks ago (0.9.2)

class Cycles

Represents a collection of time periods (cycles).

Constructors

new



Cycles(periods: ZeitPeriod[])

Creates a new Cycles instance.



findAfter(zeit?: ZeitSchema): ZeitPeriod

Finds the nearest period after the given date.



findBefore(zeit?: ZeitSchema): ZeitPeriod

Finds the nearest period before the given date.



findPeriod(zeit?: ZeitSchema): ZeitPeriod

Finds the period that contains the given date.

private



getCurrentDateTime(): DateTime

Gets the current date and time in the timezone of the first period.



getFirstPeriod(): ZeitPeriod

Gets the first period in this Cycles instance.



getLastPeriod(): ZeitPeriod

Gets the last period in this Cycles instance.



getNumberOfPeriods(): number

Gets the total number of periods in this Cycles instance.



getPeriodByIndex(index: number): ZeitPeriod

Gets the period at the specified index.



getPeriodByZeit(zeit: ZeitSchema): ZeitPeriod | undefined

Gets the period that contains the specified date.



getPeriods(): ZeitPeriod[]

Gets all periods in this Cycles instance.

private



getUserZeit(zeit: ZeitSchema): UserZeit

Converts a ZeitSchema to a UserZeit object.



fromPeriods(periods: ZeitPeriod[]): Cycles

Creates a new Cycles instance from an array of periods.

Add Package

deno add jsr:@dnl-fm/zeit-ts

Import symbol

import { Cycles } from "@dnl-fm/zeit-ts";

---- OR ----

Import directly with a jsr specifier

import { Cycles } from "jsr:@dnl-fm/zeit-ts";

Add Package

npx jsr add @dnl-fm/zeit-ts

Import symbol

import { Cycles } from "@dnl-fm/zeit-ts";

Add Package

yarn dlx jsr add @dnl-fm/zeit-ts

Import symbol

import { Cycles } from "@dnl-fm/zeit-ts";

Add Package

pnpm dlx jsr add @dnl-fm/zeit-ts

Import symbol

import { Cycles } from "@dnl-fm/zeit-ts";

Add Package

bunx jsr add @dnl-fm/zeit-ts

Import symbol

import { Cycles } from "@dnl-fm/zeit-ts";