The Meta:Magical Interface

The Meta:Magical interface provides the basic features for annoatating live objects, and querying metadata attached to them. This project is not meant for end users, but rather for tooling developers who want to use this information in their tools.

Installing

The only supported way to install the transform plugin is through npm.

NOTE
If you don't have npm yet, you'll need to install Node.js. All newer versions (4+) of Node come with npm.

$ npm install metamagical-interface

Documentation

To learn about the Interface, you can use the REPL browser. Before you can do that you'll need to download and build this project:

git clone https://github.com/origamitower/metamagical.git
cd metamagical
npm install     # install build tooling 
make all        # compiles all sub projects 

Then launch a Node REPL to browse the project:

node> var Interface = require('./packages/interface')
node> var browser = require('./packages/repl')(Interface)
node> browser.for(Interface).summary()
 
# Interface
===========
 
 
Stability: 1 - Experimental
Platforms:
    • ECMAScript 2015
 
The Meta:Magical interface allows one to query meta-data associated
with a particular object, or attach new meta-data to any object
without modifying the object.
 
    (run `.documentation()` for the full docs)
 
 
## Properties
-------------
 
### Additional reflective methods
 
    • allProperties()
      | Retrieves a categorised list of properties in the current
   context.
 
    • properties()
      | Retrieves a categorised list of properties owned by the current
   context.
 
( ... )

Support

If you think you've found a bug in the project, or want to voice your frustration about using it (maybe the documentation isn't clear enough? Maybe it takes too much effort to use?), feel free to open a new issue in the Github issue tracker.

Pull Requests are welcome. By submitting a Pull Request you agree with releasing your code under the MIT licence.

You can join the Gitter Channel for quick support. You can contact the author over email, or Twitter.

Note that all interactions in this project are subject to Origami Tower's Code of Conduct.

Licence

Meta:Magical is copyright (c) Quildreen Motta, 2016, and released under the MIT licence. See the LICENCE file in this repository for detailed information.