# fastify-apply

> Shorthand object syntax for Fastify plugins

Latest version **0.0.3** (published 2022-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install fastify-apply
pnpm add fastify-apply
yarn add fastify-apply
bun add fastify-apply
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-04-12 |
| First published | 2021-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | galvez |

## Links

- npm: https://www.npmjs.com/package/fastify-apply
- Repository: https://github.com/galvez/fastify-apply
- Issues: https://github.com/galvez/fastify-apply/issues
- npm.io page: https://npm.io/package/fastify-apply

## Recent versions

- 0.0.3 (latest) — 2022-04-12
- 0.0.2 — 2021-03-29
- 0.0.1 — 2021-03-29

## README

# fastify-apply

Experimental shorthand syntax for Fastify.

## Define hooks as functions or arrays of functions

```js
export default {
  async onRequest (req, reply) {
    reply.send(`Hello from onRequest`)
  },
  preHandler: [
    async (req, reply) => {
      reply.send('Hello from the first preHandler')
    },
    async (req, reply) => {
      reply.send('Hello from the second preHandler')
    },
  ],
}
```

Supported hooks:

- `onRequest`
- `preParsing`
- `preValidation`
- `preHandler`
- `preSerialization`
- `onError`
- `onSend`
- `onResponse`
- `onTimeout`
- `onReady`
- `onClose`
- `onRoute`
- `onRegister`

## Define method(key, value) calls

```js
export default {
  decorate: {
    helper () {
      console.log('Helper function')
    }
  },
}
```

Supported methods:

- `addHook`
- `decorate`
- `decorateRequest`
- `decorateReply`

## Run a function before() or after() everything else in the plugin

```js
export default {
  after({ get }) {
    get('/*', (req, reply) => {})
  },
  before({ get }) {
    get('/route', (req, reply) => {})
  },
}
```

The first argument to `before()` and `after()` is a `Proxy` instance
that will return **Fastify methods implictly bound to the current plugin
context** (the _contextual_ `fastify` instance, that is).

Full list of methods that come with this implicit binding: 

- `addSchema`
- `addHook`
- `decorateRequest`
- `decorateReply`
- `register`
- `get`
- `head`
- `post`
- `put`
- `delete`
- `options`
- `patch`
- `all`

## Encapsulation

Unless you set `encapsulate` to `true`, the plugin will be wrapped with [`fastify-plugin`](https://github.com/fastify/fastify-plugin) so it stays in the global context. To ensure the applied plugin object is encapsulated:

```js
export default {
  encapsulate: true,
}
```

Hat off to [Matteo Collina](https://twitter.com/matteocollina) for suggesting this option's name.

## Full example

```js
async function main () {
  const fastify = require('fastify')()
  await fastify.register(require('./index'))

  fastify.apply({
    after ({ get }) {
      get('/*', (req, reply) => {
        reply.send('/* route properly registered')
      })
    },
    decorate: {
      someHelper () {
        return 'something'
      }
    },
    decorateRequest: {
      foobar: 'something else',
      dynamic: null
    },
    async onRequest (req, reply) {
      req.dynamic = this.someHelper()
      reply.header('x-hello-1', `Hello from hooks: ${req.foobar} - ${req.dynamic}`)
    },
    preHandler: [
      async (req, reply) => {
        reply.header('x-hello-2', 'Hello from the first preHandler')
      },
      async (req, reply) => {
        reply.header('x-hello-3', 'Hello from the second preHandler')
      }
    ],
    before ({ get }) {
      get('/before', (req, reply) => {
        reply.send('/before route properly registered')
      })
    }
  })

  return fastify
}
```

---
_Source: https://npm.io/package/fastify-apply · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._