Install

NPM

$ npm install @ubrick/decorator-readonly

NPM GIT

$ npm install github:ubricks/decorator-readonly

Yarn

$ yarn add @ubrick/decorator-readonly

Usage

import readonly from 'ubrick/decorator-readonly'

class Example {
  @readonly field = 10
  @readonly static staticField = 10

  @readonly generatorMethod = (function * () {})
  @readonly asyncGeneratorMethod = (async function * () {})
  @readonly static staticGeneratorMethod = (function * () {})
  @readonly static staticAsyncGeneratorMethod = (async function * () {})

  @readonly method () {}
  @readonly async asyncMethod () {}
  @readonly static staticMethod () {}
  @readonly static async staticAsyncMethod () {}
}

Contributing

npm install
Make some changes
If necessary add some tests to tests
npm run lint
npm test
Make a Pull Request

FAQ

Why the unusual generator definition?

This is due to a bug in Babel, normal generator definition should work in Babel when babel/babel#7976 is merged.

Changelog

Contributors

Leon Pegg
- Author and maintainer

MIT License

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.