Skip to content
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

Jump to bottom

Add isValid(), fix security issues in dependency #11

Merged
merged 5 commits into from Dec 30, 2022
Merged

Add isValid(), fix security issues in dependency #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dfe2b87
fix security issues in dependency with npm audit fix
bluet Dec 29, 2022
14c2106
added: isValid()
bluet Dec 29, 2022
7685fe5
case insensitive. remove redundant import.
bluet Dec 30, 2022
112934d
case insensitive. remove redundant import.
bluet Dec 30, 2022
446926d
Make isValid more efficient
perry-mitchell Dec 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -64,6 +64,17 @@ import { decodeTime } from "ulidx";
decodeTime("01ARYZ6S41TSV4RRFFQ69G5FAV"); // 1469918176385
```

### Validate ULID

Import `isValid` to check if a string is a valid ULID:

```typescript
import { isValid } from "ulidx";

isValid("01ARYZ6S41TSV4RRFFQ69G5FAV"); // true
isValid("01ARYZ6S41TSV4RRFFQ69G5FA"); // false
```

## Pseudo-Random Number Generation (PRNG)

`ulidx` will attempt to locate a suitable cryptographically-secure random number generator in the environment where it's loaded. On NodeJS this will be `crypto.randomBytes` and in the browser it will be `crypto.getRandomValues`.
Expand Down