Nighttime Possum Meandering

    @fastify/env
    TypeScript icon, indicating that this package has built-in type declarations

    4.1.0 • Public • Published

    @fastify/env

    CI NPM version js-standard-style

    Fastify plugin to check environment variables

    Install

    npm i @fastify/env
    

    Usage

    const fastify = require('fastify')()
    const fastifyEnv = require('@fastify/env')
    
    const schema = {
      type: 'object',
      required: [ 'PORT' ],
      properties: {
        PORT: {
          type: 'string',
          default: 3000
        }
      }
    }
    
    const options = {
      confKey: 'config', // optional, default: 'config'
      schema: schema,
      data: data // optional, default: process.env
    }
    
    fastify
      .register(fastifyEnv, options)
      .ready((err) => {
        if (err) console.error(err)
    
        console.log(fastify.config) // or fastify[options.confKey]
        // output: { PORT: 3000 }
      })

    This module is a wrapper around env-schema. To read an .env file you must set dotenv in the options:

    const options = {
      dotenv: true // will read .env in root folder
    }
    
    // or, pass config options avalible on dotenv module
    const options = {
      dotenv: {
        path: `${__dirname}/.env`,
        debug: true
      }
    }

    NB Support for additional properties in the schema is disabled for this plugin, with the additionalProperties flag set to false internally.

    Typescript

    In order to have typing for the fastify instance, you should follow the example below:

    declare module 'fastify' {
      interface FastifyInstance {
        config: { // this should be same as the confKey in options
          // specify your typing here
        };
      }
    }

    Acknowledgements

    Kindly sponsored by Mia Platform

    Keywords

    Install

    npm i @fastify/env

    DownloadsWeekly Downloads

    7,522

    Version

    4.1.0

    License

    MIT

    Unpacked Size

    12.3 kB

    Total Files

    13

    Last publish

    Collaborators

    • simenb
    • coopflow
    • simoneb
    • rafaelgss
    • starptech
    • delvedor
    • matteo.collina
    • allevo
    • jsumners
    • zekth
    • ethan_arrowood
    • eomm
    • fox1t
    • davidmarkclements
    • airhorns
    • kibertoad
    • climba03003
    • is2ei
    • fdawgs