Wondering what’s next for npm?Check out our public roadmap! »

@agoric/make-hardener

0.1.1 • Public • Published

MakeHardener

Build Status dependency status dev dependency status License

Build a defensible API surface around an object by freezing all reachable properties.

How to use

Note: If you're writing an application, you probably don't want to use this package directly. You'll want to use the harden() function provided in SES to perform an all-encompassing "deep freeze" on your objects. Alternatively, if you want to test your code before using it in SES, you can import the @agoric/harden package. Note that without SES, harden() is insecure, and should be used for testing purposes only.

Why do we need to "harden" objects?

Please see the harden() package for more documentation.

Creating a custom harden() Function

This package (@agoric/make-hardener) provides a makeHardener() which can be used to build your own harden() function. When you call makeHardener(), you give it an iterable of stopping points (the "fringe"), and the recursive property walk will stop its search when it runs into the fringe. The resulting harden() will throw an exception if anything it freezes has a prototype that is not already in the fringe, or was frozen during the same call (and thus added to the fringe).

Install

npm i @agoric/make-hardener

DownloadsWeekly Downloads

2,513

Version

0.1.1

License

Apache-2.0

Unpacked Size

40.9 kB

Total Files

11

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar