Skip to content

docs(uuid): fix stale v1 JSDoc and remove unnecessary casts from examples #7285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tomas-zijdemans wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −7
Open

docs(uuid): fix stale v1 JSDoc and remove unnecessary casts from examples #7285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions uuid/mod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ import {
* import { assert } from "@std/assert";
*
* const uuid = v1.generate();
* assert(v1.validate(uuid as string));
* assert(v1.validate(uuid));
* ```
*/
export const v1 = {
Expand Down Expand Up @@ -123,7 +123,7 @@ export const v5 = {
*
* const TIMESTAMP = 1527897600000;
* const uuid = v7.generate(TIMESTAMP); // optional timestamp, otherwise defaults to Date.now();
* assert(v7.validate(uuid as string));
* assert(v7.validate(uuid));
* assertEquals(v7.extractTimestamp(uuid), TIMESTAMP);
* ```
*/
Expand Down
2 changes: 1 addition & 1 deletion uuid/unstable_v6.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export interface GenerateOptions {
* };
*
* const uuid = generate(options);
* assert(validate(uuid as string));
* assert(validate(uuid));
* ```
*/
export function generate(options: GenerateOptions = {}): string {
Expand Down
8 changes: 4 additions & 4 deletions uuid/v1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export interface GenerateOptions {
*/
msecs?: number;
/**
* The number of nanoseconds to add to {@linkcode V1Options.msecs}
* The number of nanoseconds to add to {@linkcode GenerateOptions.msecs}
* (0 - 10,000).
*
* @see {@link https://www.rfc-editor.org/rfc/rfc4122#section-4.1.4}
Expand All @@ -65,7 +65,7 @@ export interface GenerateOptions {
random?: number[];
/**
* A function that returns an array of 16 random bytes (0 - 255).
* Alternative to {@linkcode V1Options.random}.
* Alternative to {@linkcode GenerateOptions.random}.
*/
rng?: () => number[];
}
Expand All @@ -76,7 +76,7 @@ export interface GenerateOptions {
*
* @param options Can use RFC time sequence values as overwrites.
*
* @returns Returns a UUIDv1 string or an array of 16 bytes.
* @returns Returns a UUIDv1 string.
*
* @example Usage
* ```ts
Expand All @@ -91,7 +91,7 @@ export interface GenerateOptions {
* };
*
* const uuid = generate(options);
* assert(validate(uuid as string));
* assert(validate(uuid));
* ```
*/
export function generate(options: GenerateOptions = {}): string {
Expand Down
Loading