https://github.com/grassator/benign

Provides a proxy-based object that tries to look like it does everything you want
https://github.com/grassator/benign

dummy javascript mock proxy stub typescript

Last synced: 3 months ago
JSON representation

Provides a proxy-based object that tries to look like it does everything you want

• Host: GitHub
• URL: https://github.com/grassator/benign
• Owner: grassator
• License: mit
• Created: 2018-04-10T19:21:51.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-09T20:30:44.000Z (over 7 years ago)
• Last Synced: 2025-09-28T09:59:56.647Z (4 months ago)
• Topics: dummy, javascript, mock, proxy, stub, typescript
• Language: TypeScript
• Size: 24.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# benign

[![Build Status](https://travis-ci.org/grassator/benign.svg?branch=master)](https://travis-ci.org/grassator/benign)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This library provides a single exported function called `benign`, that when used provides an object that does not do anything, but also tries it's best to appear to your code as if it does.

```javascript

import { benign } from "benign";

const B = benign();

const b = new B();

console.log(b().foo().bar === b);

```

## Requirements

This package requires Proxy implementation, so should generally in all evergreen browsers. All IE browsers are not supported.

## `instanceof` handling

By default `benign` will report that everything else is an instance of `benign()`, but converse is not true:

```javascript

import { benign } from "benign";

console.log(/foo/ instanceof benign()); // true

console.log(benign() instanceof RegExp); // false

```

This is explained by the way [Symbol.hasInstance](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance) works.

## License

The MIT License (MIT)

Copyright (c) 2018 Dmitriy Kubyshkin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.