npm.io
1.0.2 • Published 2 years ago

@types/is-uuid

Licence
MIT
Version
1.0.2
Deps
0
Size
4 kB
Vulns
0
Weekly
0
Stars
51.4K

Installation

npm install --save @types/is-uuid

Summary

This package contains type definitions for is-uuid (https://github.com/afram/is-uuid#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/is-uuid.

index.d.ts

/**
 * Returns true if the value is a v1 UUID
 * @param value The value to test
 */
export function v1(value: string): boolean;

/**
 * Returns true if the value is a v2 UUID
 * @param value The value to test
 */
export function v2(value: string): boolean;

/**
 * Returns true if the value is a v3 UUID
 * @param value The value to test
 */
export function v3(value: string): boolean;

/**
 * Returns true if the value is a v4 UUID
 * @param value The value to test
 */
export function v4(value: string): boolean;

/**
 * Returns true if the value is a v5 UUID
 * @param value The value to test
 */
export function v5(value: string): boolean;

/**
 * Returns true if the value is a nil UUID
 * @param value The value to test
 */
export function nil(value: string): boolean;

/**
 * Returns true for v1 - v5 UUID. Will return false for nil UUID
 * @param value The value to test
 */
export function anyNonNil(value: string): boolean;

Additional Details

  • Last updated: Tue, 07 Nov 2023 0337 GMT
  • Dependencies: none

Credits

These definitions were written by André Thériault.