ethers.js/packages/properties/README.md

45 lines
779 B
Markdown
Raw Permalink Normal View History

2019-05-14 18:25:46 -04:00
Property Utilities
==================
This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
2019-05-14 18:25:46 -04:00
It contains several useful utility methods for managing simple objects with
defined properties.
2019-05-14 18:25:46 -04:00
For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/properties/).
Importing
---------
Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
but for those with more specific needs, individual components can be imported.
```javascript
const {
defineReadOnly,
getStatic,
resolveProperties,
checkProperties,
shallowCopy,
deepCopy,
Description,
// Types
Deferrable
} = require("@ethersproject/properties");
```
2019-05-14 18:25:46 -04:00
License
-------
MIT License