types/readme.md

30 lines
463 B
Markdown

Collection of general-purpose type definitions
```bash
# Update project npm config to refer to correct registry for the @js scope
echo '@js:registry=https://gitea.jbrumond.me/api/packages/js/npm/' >> ./.npmrc
npm install --save-dev @js/types
```
## Types
```ts
import {
// Various identifier strings
HttpURL,
UUID,
SnowflakeID,
// HTTP verbs
HttpVerb,
HttpVerbExtended,
// Pino-compatible logger interface
Logger,
LogFn,
} from '@js/types';
```