Git Product home page Git Product logo

denude's Introduction

denude npm-version

All that is hidden shall be revealed

Although testing private members is considered an antipattern, sometimes you really, really need to. Denude makes it easy to require functions and variables from the top scope of a module.

Usage

Module you want to test:

const { format } = require('util')


let prefix = 'Hello, '

function greet(name) {
  return format(`${prefix}%s!`, name)
}

function helloWorld() {
  return greet('World')
}

module.exports = { greet, helloWorld }

Test file:

const denude = require('denude')
const { helloWorld, greet: publicGreet } = denude('./module') // public parts
const { format, prefix, greet } = denude('./module?private') // private parts

console.log(greet === publicGreet) // true
console.log(helloWorld()) // Hello, World!

Notice that denude works independently from require. It means that require('./module') and denude('./module') will return different instances of all the members of the module:

const required = require('./module')
const publicDenude = denude('./module')
const privateDenude = denude('./module?private')

console.log(required.greet === publicDenude.greet) // false
console.log(privateDenude.greet === publicDenude.greet) // true

Overriding require

You can use require('denude/register') to patch the native require globally. After that, any require that is passed a path with the ?private prefix will return the private members instead of the exports.

Example:

require('denude/register')

const helloWorld = require('./module') // public parts
const { format, prefix, greet } = require('./module?private') // private parts

This technique is useful with testing frameworks like mocha and ava that allow requiring modules on run:

mocha --require denude/register test

License

ISC

denude's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.