From db9a4b2fee73f95a247c656ea1d090babce3d56d Mon Sep 17 00:00:00 2001 From: Fajar Abdi Nugraha Date: Sat, 19 Oct 2024 22:00:20 +0700 Subject: [PATCH] remove mod desc --- mod.ts | 39 --------------------------------------- 1 file changed, 39 deletions(-) diff --git a/mod.ts b/mod.ts index c62d84a..487ed64 100644 --- a/mod.ts +++ b/mod.ts @@ -1,41 +1,2 @@ -/** - * Utilities for generating and working with Universally Unique Lexicographically Sortable Identifiers (ULIDs). - * - * To generate a ULID use the {@linkcode ulid} function. This will generate a - * ULID based on the current time. - * - * ```ts no-assert - * import { ulid } from "@fajar/deno-ulid"; - * - * ulid(); - * ``` - * - * {@linkcode ulid} does not guarantee that the ULIDs will be strictly - * increasing for the same current time. If you need to guarantee that the ULIDs - * will be strictly increasing, even for the same current time, use the - * {@linkcode monotonicUlid} function. - * - * ```ts no-assert - * import { monotonicUlid } from "@fajar/deno-ulid"; - * - * monotonicUlid(); // 01HYFKHG5F8RHM2PM3D7NSTDAS - * monotonicUlid(); // 01HYFKHG5F8RHM2PM3D7NSTDAT - * ``` - * - * Because each ULID encodes the time it was generated, you can extract the - * timestamp from a ULID using the {@linkcode decodeTime} function. - * - * ```ts - * import { decodeTime, ulid } from "@fajar/deno-ulid"; - * import { assertEquals } from "@std/assert"; - * - * const timestamp = 150_000; - * const ulidString = ulid(timestamp); - * - * assertEquals(decodeTime(ulidString), timestamp); - * ``` - * - * @module - */ export * from "./lib/index.ts"; export type * from "./types/index.d.ts";