@fwgapps/namecheap
v0.6.0
Published
A simple and efficient TypeScript library for interacting with the Namecheap API, returning structured JSON responses.
Maintainers
Readme
@fwgapps/namecheap
A clean and simple TypeScript wrapper for the Namecheap API, with strongly typed responses and modern developer ergonomics.
Table of Contents
Description
A lightweight and developer-friendly TypeScript client for the Namecheap API. Designed for both Node.js and browser environments, it provides full type safety with comprehensive TypeScript definitions. This library simplifies and automates domain management tasks, enabling developers to integrate Namecheap's services seamlessly into their applications.
Features
- Fully typed API responses using TypeScript
- Supports both ESM and CommonJS projects
- Easy-to-use, object-oriented interface
- Works in Node.js and modern runtimes
- Includes real-world usage examples with Express.js
Installation
You can install the library via npm or yarn:
Using npm
npm install @fwgapps/namecheapUsing yarn
yarn add @fwgapps/namecheapBrowser / CDN Usage
You can also use the library directly in the browser via CDN without bundlers or Node.js.
Just include this script tag in your HTML:
<script src="https://cdn.jsdelivr.net/npm/@fwgapps/namecheap/dist/index.global.js"></script>Examples
The repository contains real examples, including usage with Express.js:
git clone [email protected]:fwgapps/namecheap.git
cd examples/express
yarn
yarn run devRunning Tests
We use Vitest for unit testing:
yarn testScripts
build: Compile the code using tsuptest: Run tests with Vitestlint: Lint code using ESLintrelease: Release a new version using semantic-release
API Coverage
Check the API Docs for full endpoint support. This library aims to cover the most-used endpoints first, with plans to expand.
License
This project is licensed under the ISC License.
Contributing
Feel free to open an issue or submit a pull request if you'd like to contribute!
