@kingjs/i-interface

IInterface.Id is found on functions representing interfaces and stores the symbol identifying the interface.

Usage

var assert = require('assert');

// an interface, in the abstract, is just 
// a symbolic name representing a collection 
// of of symbols (just one in this case).
var Id = Symbol.for('@kingjs/IInterface.id');

// the name and symbol collection are 
// gathered onto an abstract function
var IInterface = require('@kingjs/i-interface');
assert(IInterface instanceof Function);
assert(IInterface.prototype == null);
assert(IInterface.constructor == null);
assert.throws(() => new IInterface);

// the identifying symbol is stored in Id on the function
assert(IInterface[Id] == Id);

// the reason a function is used as the 
// underlying object representing interfaces
// is so that instances can be tested to
// see if they implement an interface
assert(Symbol.hasInstance in IInterface);

// It's mind bending, but the function 
// itself is an instance implementing IInterface
assert(IInterface instanceof IInterface);

Install

With npm installed, run

$ npm install @kingjs/i-interface

Dependencies

|Package|Version| |---|---| |@kingjs/reflect.create-interface|^1.0.0|

Source

https://repository.kingjs.net/i-interface

License

MIT