mirror of
https://github.com/flynx/object-run.js.git
synced 2025-10-31 12:00:07 +00:00
94 lines
1.7 KiB
Markdown
94 lines
1.7 KiB
Markdown
# object-run.js
|
|
|
|
_object-run.js_ implements the tools needed to use the [Concatinative
|
|
Programming Style](https://en.wikipedia.org/wiki/Concatenative_programming_language)
|
|
on native JavaScript structures/objects.
|
|
|
|
This module defines a singe method `.run(..)` on `Object.prototype` making
|
|
it visible from all JavaScript objects inheriting from `Object`.
|
|
|
|
The `.run(..)` method simply executes a function in the context of the
|
|
object from which `.run(..)` was called. The return value of `.run(..)`
|
|
is the non-`undefined` return value of the passed function or the context
|
|
object otherwise.
|
|
|
|
|
|
## Installation
|
|
|
|
```shell
|
|
$ npm install --save object-run
|
|
```
|
|
|
|
## Basic usage
|
|
|
|
```javascript
|
|
require('object-run')
|
|
```
|
|
|
|
```javascript
|
|
var o = {}
|
|
.run(function(){
|
|
this.x = 123
|
|
this.y = 321
|
|
})
|
|
```
|
|
|
|
Conditionaly run a function...
|
|
```javascript
|
|
var o = {}
|
|
.run(o.x % 2 == 0,
|
|
function(){
|
|
this.x_is_odd = true
|
|
})
|
|
```
|
|
|
|
## Examples
|
|
|
|
```javascript
|
|
var l = [1, 2, 3, 4, 5]
|
|
// keep only even elements...
|
|
.filter(function(e){
|
|
return e % 2 == 0 })
|
|
.sort()
|
|
// if length is not even add an extra even number at the end...
|
|
.run(function(){
|
|
this.length % 2 != 0
|
|
&& this.push(this[this.length-1] + 2) })
|
|
```
|
|
|
|
|
|
|
|
## Components
|
|
|
|
### `Object.prototype.run(..)`
|
|
|
|
```
|
|
<obj>.run(<func>)
|
|
-> <obj>
|
|
-> <return-value>
|
|
|
|
<obj>.run(<cond>, <func>)
|
|
-> <obj>
|
|
-> <return-value>
|
|
```
|
|
|
|
```
|
|
<func>()
|
|
-> undefined
|
|
-> <return-value>
|
|
```
|
|
|
|
If `<func>()` returns `undefined` then `.run(..)` will return `<obj>`.
|
|
|
|
|
|
|
|
## License
|
|
|
|
[BSD 3-Clause License](./LICENSE)
|
|
|
|
Copyright (c) 2016-2020, Alex A. Naanou,
|
|
All rights reserved.
|
|
|
|
|
|
<!-- vim:set ts=4 sw=4 spell : -->
|