@nauverse/make-url

make-url

Build correct URLs easily.

How?

Install

Currently, the package is distributed via NPM.

npm install --save test

Usage with Node (CommonJS/CJS)

Node 18 and above are officially supported, though you may have luck using it with an earlier Node version. Since the code uses the URL and URLSearchParams classes internally, which aren't available below Node v10, the library is known not to work with those versions.

TypeScript

This library provides its own type definitions. "It just works", no need to install anything from @types.

Help

Thank you for using make-url!

If you need any help using this library, feel free to create a GitHub issue, and ask your questions. I'll try to answer as quickly as possible.

Contribute

Contributions of any kind (pull requests, bug reports, feature requests, documentation, design) are more than welcome! If you like this project and want to help, but feel like you are stuck, feel free to contact the maintainers.

Building from source

Building the project should be quick and easy. If it isn't, it's the maintainer's fault. Please report any problems with building in a GitHub issue.

You need to have a reasonably recent version of node.js to build urlcat. Tested on node version 18.0.0 and npm version 8.6.0.

First, clone the git repository:

git clone [e-mail]:TheNaubit/make-url.git

Then switch to the newly created urlcat directory and install the dependencies:

cd make-url
npm install

You can then run the unit tests to verify that everything works correctly:

npm run test:run

And finally, build the library:

npm run build

The output will appear in the dist directory.

Happy hacking!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Al | Naucode 🐛 💻 📖 🚧 ⚠️ 🚇

This project follows the all-contributors specification. Contributions of any kind welcome!