Skip to content

Pretend the current process is running on a given platform

License

Notifications You must be signed in to change notification settings

shinnn/pretend-platform

Repository files navigation

pretend-platform

npm version Build Status Coverage Status

A Node.js module to pretend the current process is running on a given platform

const pretendPlatform = require('pretend-platform');

process.platform; //=> 'darwin'

pretendPlatform('win32');
process.platform; //=> 'win32'

Installation

Use npm.

npm install pretend-platform

API

const pretendPlatform = require('pretend-platform');

pretendPlatform(platform)

platform: string (a platform name to pretend)
Return: string (the pretended platform name)

It modifies process.platform into the given value.

pretendPlatform.restore()

Return: String (pretendPlatform.original)

It restores process.platform to the original value.

const pretendPlatform = require('pretend-platform');

process.platform; //=> 'linux'

pretendPlatform('freebsd');
process.platform; //=> 'freebsd'

pretendPlatform.restore();
process.platform; //=> 'linux'

pretendPlatform.original

Type: string

The read-only property preserving the original process.platform.

License

ISC License © 2019 Shinnosuke Watanabe

About

Pretend the current process is running on a given platform

Resources

License

Stars

Watchers

Forks

Packages

No packages published