# ifjs

> Native implementation of interfaces for js

Latest version **0.0.4** (published 2015-07-11) · 0 weekly downloads

## Install

```sh
npm install ifjs
pnpm add ifjs
yarn add ifjs
bun add ifjs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2015-07-11 |
| First published | 2015-07-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | swvitaliy |
| Maintainers | swvitaliy |

## Links

- npm: https://www.npmjs.com/package/ifjs
- Repository: https://github.com/swvitaliy/ifjs
- Issues: https://github.com/swvitaliy/ifjs/issues
- npm.io page: https://npm.io/package/ifjs

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^3.10.0

## Recent versions

- 0.0.4 (latest) — 2015-07-11
- 0.0.3 — 2015-07-11
- 0.0.2 — 2015-07-11
- 0.0.1 — 2015-07-11

## README

# ifjs
Native implementation of interfaces for js

[![npm](http://img.shields.io/npm/v/ifjs.svg)](https://www.npmjs.org/package/ifjs)
[![Build Status](https://travis-ci.org/swvitaliy/ifjs.svg?branch=master)](https://travis-ci.org/swvitaliy/ifjs)
[![Code Climate](https://codeclimate.com/github/swvitaliy/ifjs/badges/gpa.svg)](https://codeclimate.com/github/swvitaliy/ifjs)
[![Dependency Status](https://david-dm.org/swvitaliy/ifjs.svg)](https://david-dm.org/swvitaliy/ifjs)
[![Build Status](https://drone.io/github.com/swvitaliy/ifjs/status.png)](https://drone.io/github.com/swvitaliy/ifjs/latest)


[Simple Example](examples/collection.js)

To describe the parameters or return values so you can use native js types (except null and undefined).

```javacript
var ICalc = new Interface('ICalc', { sum: {args: [Number, Number], result: Number},
        dif: {args: [Number, Number], result: Number} });

var IStringConcat = new Interface('IStringConcat', { concat: {args: [String, String], result: String} });

var IMatch = new Interface('IMatch', { match: {args: [RegExp], result: Boolean} });
```

In addition, in the description of the arguments to a function in the interface (or return values) can be used
a constructor function, for example:

```javacript
function F() {}
F.prototype.fn = function() { return '\' nruter } ()noitcnuf = nf.epytotorp.F'; }

var IFClient = new Interface('IFClient', {
  run: [F]
});

function FClient() {}

Class(FClient, null, [IFClient], {
  run: function(obj) {
    console.log(obj.fn());
  };
});

var f = new F();
var fclient = new FClient();

fclient.run(f);
```

can pass as an interface object, not wrapped `new Interface(...)`

```javacript
Class({}, null, [{ fn: [] }], { fn: function() { return 'Yes, we can!'; } });
```

If you pass only one interface, you can omit the brackets "[...]".

```javacript
Class({}, null, { fn: { args: [], result: String } },
    { fn: function() { return '1234567890'; } });
```

More examples are in [Russian localization](README_ru.md).


[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/swvitaliy/ifjs/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

---
_Source: https://npm.io/package/ifjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._