Noteworthy Programming Masterpiece

    aurelia-metadata
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.7 • Public • Published

    aurelia-metadata

    npm Version ZenHub Join the chat at https://gitter.im/aurelia/discuss CircleCI

    This library is part of the Aurelia platform and contains utilities for reading and writing the metadata of JavaScript functions. It provides a consistent way of accessing type, annotation and origin metadata across a number of languages and formats. This library supports TypeScript metadata and contains helper functions that understand several simple, alternate locations and formats for metadata which are more easily leveraged by developers authoring code in plain ES6 or ES5.

    To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions, please join our community on Gitter or use stack overflow. Documentation can be found in our developer hub. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards.

    Platform Support

    This library can be used in the browser as well as on the server.

    Building The Code

    To build the code, follow these steps.

    1. Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.

    2. From the project folder, execute the following command:

      npm install
    3. Ensure that Gulp is installed. If you need to install it, use the following command:

      npm install -g gulp
    4. To build the code, you can now run:

      gulp build
    5. You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

    6. See gulpfile.js for other tasks related to generating the docs and linting.

    Running The Tests

    To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

    1. Ensure that the Karma CLI is installed. If you need to install it, use the following command:

      npm install -g karma-cli
    2. Ensure that jspm is installed. If you need to install it, use the following commnand:

      npm install -g jspm
    3. Download the SystemJS module loader:

      jspm dl-loader
    4. Ensure that you have Chrome installed. Karma runs the test suite in Chrome.

    5. You can now run the tests with this command:

      karma start

    Install

    npm i aurelia-metadata

    Homepage

    aurelia.io

    DownloadsWeekly Downloads

    12,037

    Version

    1.0.7

    License

    MIT

    Unpacked Size

    114 kB

    Total Files

    25

    Last publish

    Collaborators

    • cmichaelgraham
    • eisenbergeffect
    • aureliaeffect