https://github.com/santi100a/npm-library-template
This template helps you make a quick TS project with the same config and toolchain I use.
https://github.com/santi100a/npm-library-template
npm scaffold template typescript-template-project
Last synced: about 1 month ago
JSON representation
This template helps you make a quick TS project with the same config and toolchain I use.
- Host: GitHub
- URL: https://github.com/santi100a/npm-library-template
- Owner: santi100a
- License: mit
- Created: 2023-04-22T01:08:42.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-01T22:24:51.000Z (5 months ago)
- Last Synced: 2026-01-07T09:14:49.817Z (5 months ago)
- Topics: npm, scaffold, template, typescript-template-project
- Language: TypeScript
- Homepage:
- Size: 306 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Santi's DICT Client
[![Build Status][workflow badge]][repo actions]
[![npm homepage][npm badge]][npm home]
[![GitHub stars][stars badge]][repo url]
[![License][license badge]][repo url]
[![Bundlephobia stats][bundlephobia badge]][bundlephobia url]
[workflow badge]: https://github.com/santi100a/dict-client/actions/workflows/ci.yml/badge.svg
[npm badge]: https://img.shields.io/npm/v/@santi100a/dict-client
[stars badge]: https://img.shields.io/github/stars/santi100a/dict-client.svg
[license badge]: https://img.shields.io/github/license/santi100a/dict-client.svg
[bundlephobia badge]: https://img.shields.io/bundlephobia/min/@santi100a/dict-client
[npm home]: https://npmjs.org/package/@santi100a/dict-client
[repo actions]: https://github.com/santi100a/dict-client/actions
[repo url]: https://github.com/santi100a/dict-client
[bundlephobia url]: https://bundlephobia.com/package/@santi100a/dict-client@latest
## Description
This NPM package is a promise-based DICT (RFC 2229) client used to retrieve word definitions from a DICT server.
Since it needs a raw TCP socket in order to function properly, it is based on the `node:net` module and, thus,
only works on Node.js for now.
## Installation
- Via NPM: `npm install @santi100a/dict-client`
- Via Yarn: `yarn add @santi100a/dict-client`
- Via PNPM: `pnpm install @santi100a/dict-client`
## Usage examples
```typescript
import { DictClient } from '@santi100a/dict-client';
const { DictClient } = require('@santi100a/dict-client');
```