https://github.com/therealsamf/fastify-url

A plugin to provide access to a URL object
https://github.com/therealsamf/fastify-url

fastify url

Last synced: 4 days ago
JSON representation

A plugin to provide access to a URL object

• Host: GitHub
• URL: https://github.com/therealsamf/fastify-url
• Owner: therealsamf
• License: mit
• Created: 2019-04-06T23:42:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T04:59:41.000Z (about 2 years ago)
• Last Synced: 2024-11-01T19:24:09.832Z (about 2 months ago)
• Topics: fastify, url
• Language: TypeScript
• Size: 1.59 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
fastify-url

===========

[![NPM](https://img.shields.io/npm/v/fastify-url.svg)](https://www.npmjs.com/package/fastify-url)

[![Build Status](https://travis-ci.org/therealsamf/fastify-url.svg?branch=master)](https://travis-ci.org/therealsamf/fastify-url)

[![codecov.io Code Coverage](https://img.shields.io/codecov/c/github/therealsamf/fastify-url.svg?maxAge=2592000)](https://codecov.io/github/therealsamf/fastify-url?branch=master) [![Greenkeeper badge](https://badges.greenkeeper.io/therealsamf/fastify-url.svg)](https://greenkeeper.io/)

A plugin for [fastify](https://www.fastify.io/) for accessing an incoming [request](https://www.fastify.io/docs/latest/Request/)'s URL data.

`fastify-url` is inspired by [`fastify-url-data`](https://github.com/fastify/fastify-url-data) and is just a thin wrapper around Node's [URL](https://nodejs.org/api/url.html#url_class_url) object.

## Usage

```javascript

const fastify = require('fastify')();

fastify.register(require('fastify-url').default);

fastify.get('/*', (req, reply) => {

  const url = req.url();

  req.log.info(url.host);          // 'sub.example.com:8080'

  req.log.info(url.hostname);      // 'sub.example.com'

  req.log.info(url.href);          // 'http://user:[email protected]:8080/p/a/t/h?query=string'

  req.log.info(url.origin);        // 'http://sub.example.com:8080'

  req.log.info(url.password);      // 'pass'

  req.log.info(url.pathname);      // '/p/a/t/h'

  req.log.info(url.port);          // '8080'

  req.log.info(url.protocol);      // 'http:'

  req.log.info(url.search);        // '?query=string'

  req.log.info(url.username);      // 'user'

  // if you just need single data:

  req.log.info(req.url('pathname')); // '/p/a/t/h'

  reply.send();

});

// GET: 'http://user:[email protected]:8080/p/a/t/h?query=string'

```

## Options

### protocol

Type: `string`

Default: `http`

This property allows you to change the protocol the incoming request's URL object will absorb. This is used because it's difficult to find the protocol the request was received from within the request handler.

## `fastify-url` vs `fastify-url-data`

The difference between these two plugins is `fastify-url` uses the native NodeJS [URL](https://nodejs.org/api/url.html#url_class_url) class and `fastify-url-data` uses [`uri-js`](https://github.com/garycourt/uri-js). These implementations provide some of the same features but have different data members. Depending on your requirements you may need one or the other, but using both is redundant.