Skip to content

Commit ccab8d3

Browse files
committed
update readme
1 parent e32e420 commit ccab8d3

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -86,25 +86,25 @@ When you import this library, you obtain the freedom that comes from having thos
8686

8787
# Introduction
8888

89-
rubico is a library for async-enabled functional programming in JavaScript. The library methods support a simple and composable functional style in asynchronous environments.
89+
rubico is a library for async-enabled functional programming in JavaScript. The library operators support a simple and composable functional style in asynchronous environments.
9090

9191
```javascript
9292
const {
9393
// compose functions
94-
pipe, compose,
95-
96-
// handle effects
97-
tap, forEach,
94+
pipe, compose, tap,
9895

9996
// control flow
10097
switchCase,
10198

10299
// handle errors
103100
tryCatch,
104101

105-
// handle objects
102+
// compose data
106103
all, assign, get, set, pick, omit,
107104

105+
// iterate
106+
forEach,
107+
108108
// transform data
109109
map, filter, reduce, transform, flatMap,
110110

@@ -119,7 +119,7 @@ const {
119119
} = rubico
120120
```
121121

122-
With async-enabled, or [a]synchronous, functional programming, functions provided to the rubico methods may be asynchronous and return a Promise. Any promises in argument position are also resolved before continuing with the operation.
122+
With async-enabled, or [a]synchronous, functional programming, functions provided to the rubico operators may be asynchronous and return a Promise. Any promises in argument position are also resolved before continuing with the operation.
123123

124124
```javascript [playground]
125125
const helloPromise = Promise.resolve('hello')
@@ -133,7 +133,7 @@ pipe(helloPromise, [ // helloPromise is resolved for 'hello'
133133
])
134134
```
135135

136-
Most methods support both an eager and a lazy API. The eager API takes all required arguments and executes at once, while its lazy API takes only the non-data arguments and executes lazily, returning a function that expects the data arguments. This dual API supports a natural and composable code style.
136+
All rubico operators support both an eager and a lazy API. The eager API takes all required arguments and executes at once, while its lazy API takes only the non-data arguments and executes lazily, returning a function that expects the data arguments. This dual API supports a natural and composable code style.
137137

138138
```javascript [playground]
139139
const myObj = { a: 1, b: 2, c: 3 }
@@ -150,7 +150,7 @@ console.log(myDuplicatedSquaredObject)
150150
// { a: [1, 1], b: [4, 4], c: [9, 9] }
151151
```
152152

153-
The rubico methods are versatile and act on a wide range of vanilla JavaScript types to create declarative, extensible, and async-enabled function compositions. The same operator `map` can act on an array and also a `Map` data structure.
153+
The rubico operators are versatile and act on a wide range of vanilla JavaScript types to create declarative, extensible, and async-enabled function compositions. The same operator `map` can act on an array and also a `Map` data structure.
154154

155155
```javascript [playground]
156156
const { pipe, tap, map, filter } = rubico
@@ -203,7 +203,7 @@ pipe(todoIDs, [
203203
])
204204
```
205205

206-
rubico offers transducers in its `Transducer` module. You can consume these transducers with the `transform` and `compose` methods. You should use `compose` over `pipe` to chain a left-to-right composition of transducers.
206+
rubico offers transducers in its `Transducer` module. You can consume these transducers with the `transform` and `compose` operators. You should use `compose` over `pipe` to chain a left-to-right composition of transducers.
207207

208208
```javascript [playground]
209209
const isOdd = number => number % 2 == 1
@@ -227,12 +227,12 @@ pipe(generateNumbers(), [
227227
])
228228
```
229229

230-
For advanced asynchronous use cases, some of the methods have property functions that have different asynchronous behavior, e.g.
230+
For advanced asynchronous use cases, some of the operators have property functions that have different asynchronous behavior, e.g.
231231
* `map` - apply a mapper function concurrently
232232
* `map.pool` - apply a mapper function concurrently with a concurrency limit
233233
* `map.series` - apply a mapper function serially
234234

235-
For more functions beyond the core methods, please visit `rubico/x`. You can find the full documentation at [rubico.land/docs](https://rubico.land/docs).
235+
For more functions beyond the core operators, please visit `rubico/x`. You can find the full documentation at [rubico.land/docs](https://rubico.land/docs).
236236

237237
# Benchmarks
238238
Please find the published benchmark output inside the [benchmark-output](https://github.com/a-synchronous/rubico/tree/master/benchmark-output) folder. You can run the benchmarks on your own system with the following command:

0 commit comments

Comments
 (0)