Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

hostenv

bevry493Artistic-2.04.9.0TypeScript support: included

Exports the correct PORT and HOSTNAME values for Heroku, AppFog, CloudFoundry, OpenShift, and other service environments

allow-env, allow-read, appfog, cloudfoundry, deno, deno-edition, deno-entry, denoland, env, environment, es2022, heroku, hostname, node, openshift, paas, port, typed, types, typescript

readme

hostenv

Status of the GitHub Workflow: bevry NPM version NPM downloads
GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button
Discord server badge Twitch community badge

Exports the correct PORT and HOSTNAME values for Heroku, AppFog, CloudFoundry, OpenShift, and other service environments

Supports:

  • $PORT, $HOSTNAME - Heroku, Nodejitsu
  • $OPENSHIFT_NODEJS_PORT, $OPENSHIFT_NODEJS_IP - 1, 2
  • $OPENSHIFT_IOJS_PORT, $OPENSHIFT_IOJS_IP - 1, 2
  • $PORT, $VCAP_APP_PORT, $VCAP_APP_HOST - CloudFoundry
  • $VMC_APP_PORT, $VMC_APP_HOST - AppFog (Legacy CloudFoundry)

Usage

Complete API Documentation.

const { PORT, HOSTNAME } = require('hostenv')
const port = PORT || 8080
const hostname = HOSTNAME || '0.0.0.0'

Install

npm

  • Install: npm install --save hostenv
  • Import: import * as pkg from ('hostenv')
  • Require: const pkg = require('hostenv')

Deno

import * as pkg from 'https://unpkg.com/hostenv@^4.9.0/edition-deno/index.ts'

Editions

This package is published with the following editions:

  • hostenv/source/index.ts is TypeScript source code with Import for modules
  • hostenv aliases hostenv/edition-es2022/index.js
  • hostenv/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
  • hostenv/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
  • hostenv/edition-types/index.d.ts is TypeScript compiled Types with Import for modules
  • hostenv/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

Discover the release history by heading on over to the HISTORY.md file.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Maintainers

Contributors

Finances

GitHub Sponsors donate button ThanksDev donate button Patreon donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button

Sponsors

  • Andrew Nesbitt — Software engineer and researcher
  • Balsa — We're Balsa, and we're building tools for builders.
  • Codecov — Empower developers with tools to improve code quality and testing.
  • Poonacha Medappa
  • Rob Morris
  • Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
  • Syntax — Syntax Podcast

Donors

License

Unless stated otherwise all works are:

and licensed under:

changelog

History

v4.9.0 2023 December 30

v4.8.0 2023 December 29

v4.7.0 2023 December 27

v4.6.0 2023 December 6

v4.5.0 2023 November 25

v4.4.0 2023 November 21

v4.3.0 2023 November 15

v4.2.0 2023 November 13

v4.1.0 2023 November 13

v4.0.1 2023 November 2

  • Rerelease of v3.19.0 as v4.0.1 due to a v4.0.0 release that incorrectly constricted node.js engine support.

v3.19.0 2023 November 2

v3.18.0 2021 July 30

v3.17.0 2021 July 29

v3.16.0 2021 July 28

v3.15.0 2020 October 29

v3.14.0 2020 October 29

v3.13.0 2020 September 4

v3.12.0 2020 August 18

v3.11.0 2020 August 4

v3.10.0 2020 July 22

v3.9.0 2020 June 25

v3.8.0 2020 June 21

v3.7.0 2020 June 21

v3.6.0 2020 June 20

v3.5.0 2020 June 10

v3.4.0 2020 June 10

v3.3.0 2020 May 22

v3.2.0 2020 May 21

v3.1.0 2020 May 21

v3.0.0 2020 May 6

  • Updated dependencies, base files, and editions using boundation
  • Minimum required node version changed from node: >=8 to node: >=10 to keep up with mandatory ecosystem changes

v2.3.0 2019 December 9

v2.2.0 2019 December 1

v2.1.0 2019 December 1

v2.0.0 2019 November 18

  • Updated dependencies, base files, and editions using boundation
  • Minimum required node version changed from node: >=0.8 to node: >=8 to keep up with mandatory ecosystem changes

v1.1.0 2019 November 13

v1.0.6 2018 September 4

  • Updated base files

v1.0.5 2015 December 12

  • Removed travis badge as we have no need for it

v1.0.4 2015 December 12

  • Updated internal conventions

v1.0.3 2015 August 20

  • Added support for CloudFoundry and AppFog host variables

v1.0.2 2015 August 20

v1.0.1 2015 August 15

  • Multiline file
  • Removed travis badge as there is no need for tests

v1.0.0 2015 August 12

  • Initial working version with support for Heroku, AppFog, CloudFoundry, OpenShift, and other environments