Skip to content

Commit

Permalink
🔍 Replace occurences of zenika-open-source.github.io/immutadot by imm…
Browse files Browse the repository at this point in the history
…utadot.zenika.com
  • Loading branch information
nlepage committed Jun 4, 2019
1 parent cdf637b commit 66efce3
Show file tree
Hide file tree
Showing 11 changed files with 51 additions and 51 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ immutadot gives you a short and meaningful syntax to apply operations on immutab

[![npm version](https://badge.fury.io/js/immutadot.svg)](https://badge.fury.io/js/immutadot)
[![Try on RunKit](https://badge.runkitcdn.com/immutadot.svg)](https://npm.runkit.com/immutadot)
[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://zenika-open-source.github.io/immutadot/api/immutadot)
[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://immutadot.zenika.com/api/immutadot)

[![CircleCI](https://circleci.com/gh/zenika-open-source/immutadot.svg?style=shield&circle-token=8b309750f5785783ec9fb4531ba097da60563beb)](https://circleci.com/gh/zenika-open-source/immutadot)
[![codecov](https://codecov.io/gh/zenika-open-source/immutadot/branch/master/graph/badge.svg)](https://codecov.io/gh/zenika-open-source/immutadot)
Expand Down Expand Up @@ -62,7 +62,7 @@ const { set } = require('immutadot')

### Example

Quickly set nested properties using [set()](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.set)
Quickly set nested properties using [set()](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.set)

```js
import { set } from 'immutadot'
Expand Down Expand Up @@ -91,8 +91,8 @@ A fast overview of immutadot's features is available in the [Getting started](ht
### API

The detailed API documentations of the different packages are available here:
- [immutadot](https://zenika-open-source.github.io/immutadot/api/immutadot)
- [immutadot-lodash](https://zenika-open-source.github.io/immutadot/api/immutadot-lodash/)
- [immutadot](https://immutadot.zenika.com/api/immutadot)
- [immutadot-lodash](https://immutadot.zenika.com/api/immutadot-lodash/)

Looking for older versions API documentation? Links are available [here](https://github.com/zenika-open-source/immutadot/blob/master/docs/README.md).

Expand Down Expand Up @@ -157,7 +157,7 @@ immutadot uses plain JavaScript objects so you can access your data using standa

### Exhaustive and yet extensible

immutadot comes with a large set of built-in utilities, mostly based on [ES2015+](https://mdn.io/JavaScript/Reference). You can also find a package called [immutadot-lodash](https://github.com/zenika-open-source/immutadot/tree/master/packages/immutadot-lodash) with some of [lodash](https://lodash.com/)'s utilities. You haven't found what you're looking for? Do it yourself with the [`convert`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.convert) feature.
immutadot comes with a large set of built-in utilities, mostly based on [ES2015+](https://mdn.io/JavaScript/Reference). You can also find a package called [immutadot-lodash](https://github.com/zenika-open-source/immutadot/tree/master/packages/immutadot-lodash) with some of [lodash](https://lodash.com/)'s utilities. You haven't found what you're looking for? Do it yourself with the [`convert`](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.convert) feature.

### Learning curve

Expand Down
16 changes: 8 additions & 8 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ const newAnimals = {
}
```

This can be done nicely with [`set()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.set):
This can be done nicely with [`set()`](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.set):

```js
import { set } from 'immutadot'
Expand All @@ -76,11 +76,11 @@ const animals = {
const newAnimals = set(animals, 'weasels.lutraLutra.name', 'Lutra lutra')
```

Deleting a nested property can be done with [`unset()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.unset).
Deleting a nested property can be done with [`unset()`](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.unset).

## Basic array operations

Values can be added in a nested array with [`push()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/array.html#.push):
Values can be added in a nested array with [`push()`](https://immutadot.zenika.com/api/immutadot/1.0/array.html#.push):

```js
import { push } from 'immutadot'
Expand All @@ -98,13 +98,13 @@ const animals = {
const newAnimals = push(animals, 'weasels.lutraLutra.commonNames', 'european otter', 'common otter')
```

immutadot includes all common functions of Array's prototype, see [documentation's array section](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/array.html).
immutadot includes all common functions of Array's prototype, see [documentation's array section](https://immutadot.zenika.com/api/immutadot/1.0/array.html).

## Updating properties

immutadot offers basic functions to work with primitive types such as [`toggle()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/lang.html#.toggle), [`stringConcat()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/string.html#.concat), or [`add()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/lang.html#.add), see [immutadot's API](https://zenika-open-source.github.io/immutadot/api/immutadot/) for a full list.
immutadot offers basic functions to work with primitive types such as [`toggle()`](https://immutadot.zenika.com/api/immutadot/1.0/lang.html#.toggle), [`stringConcat()`](https://immutadot.zenika.com/api/immutadot/1.0/string.html#.concat), or [`add()`](https://immutadot.zenika.com/api/immutadot/1.0/lang.html#.add), see [immutadot's API](https://immutadot.zenika.com/api/immutadot/) for a full list.

It is also possible to perform custom updates with [`update()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.update):
It is also possible to perform custom updates with [`update()`](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.update):

```js
import { update } from 'immutadot'
Expand Down Expand Up @@ -184,7 +184,7 @@ For more information on the path notation of immutadot, see the [path notation d

## Grouping modifications

Different operations can be grouped with [`flow()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/flow.html#.flow):
Different operations can be grouped with [`flow()`](https://immutadot.zenika.com/api/immutadot/1.0/flow.html#.flow):

```js
import { flow, push, set } from 'immutadot'
Expand Down Expand Up @@ -229,7 +229,7 @@ const newAnimals = set('weasels.lutraLutra.scientificName', 'Lutra lutra')(anima

## Reusing custom updates

New immutadot functions can be created with [`convert()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.convert):
New immutadot functions can be created with [`convert()`](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.convert):

```js
import { convert } from 'immutadot'
Expand Down
16 changes: 8 additions & 8 deletions docs/MIGRATING_TO_1_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ The core of immutadot has been rewritten without [lodash](https://lodash.com/),

immutadot package now contains exclusively functions based on [ES2015+ language and standard library](https://mdn.io/JavaScript/Reference).

For a complete list see [immutadot's API documentation](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/).
For a complete list see [immutadot's API documentation](https://immutadot.zenika.com/api/immutadot/1.0/).

immutadot's organization in namespaces has changed a little, see [Namespaces modifications](#namespaces-modifications) for more details.

Some functions such as [`filter()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/array.html#.filter) and [`map()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/array.html#.map) are now available in immutadot and in immutadot-lodash. This is because immutadot's version handles only arrays whereas immutadot-lodash's version handles collections (which includes objects), it is up to you to choose which version suits best your needs.
Some functions such as [`filter()`](https://immutadot.zenika.com/api/immutadot/1.0/array.html#.filter) and [`map()`](https://immutadot.zenika.com/api/immutadot/1.0/array.html#.map) are now available in immutadot and in immutadot-lodash. This is because immutadot's version handles only arrays whereas immutadot-lodash's version handles collections (which includes objects), it is up to you to choose which version suits best your needs.

### immutadot-lodash package

All immutadot functions directly based on lodash utilities (such as [`mapValues()`](https://zenika-open-source.github.io/immutadot/api/immutadot-lodash/1.0/object.html#.mapValues)) have been moved into immutadot-lodash.
All immutadot functions directly based on lodash utilities (such as [`mapValues()`](https://immutadot.zenika.com/api/immutadot-lodash/1.0/object.html#.mapValues)) have been moved into immutadot-lodash.

For a complete list see [immutadot-lodash's API documentation](https://zenika-open-source.github.io/immutadot/api/immutadot-lodash/1.0/).
For a complete list see [immutadot-lodash's API documentation](https://immutadot.zenika.com/api/immutadot-lodash/1.0/).

Such cases are easily migrated:
```diff
Expand All @@ -41,7 +41,7 @@ immutadot functions now support currying the `obj` (leftmost) parameter:
set('nested.prop', 'val')(obj)
```

This allows them to be used in [`flow()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.flow) (see [Chained operations](#chained-operations)).
This allows them to be used in [`flow()`](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.flow) (see [Chained operations](#chained-operations)).

Partial functions returned by calls without `obj` are unary, therefore you may call them with more than one parameter, only the first one will be used:

Expand All @@ -51,7 +51,7 @@ set('nested.prop', 'val')(obj, discarded1, discarded2)

## Chained operations

[`chain()`](https://zenika-open-source.github.io/immutadot/api/immutadot/0.3/seq.html#.chain) has been removed in favor of [`flow()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.flow).
[`chain()`](https://immutadot.zenika.com/api/immutadot/0.3/seq.html#.chain) has been removed in favor of [`flow()`](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.flow).

The main reasons behind this are that `chain` had some major drawbacks:
- Imports all of immutadot's functions
Expand Down Expand Up @@ -127,11 +127,11 @@ You might be able to rewrite some of your code like this:

### `using()` utility

[`using()`](https://zenika-open-source.github.io/immutadot/api/immutadot/0.3/util.html#.using) has been removed for the same reasons as `chain()`:
[`using()`](https://immutadot.zenika.com/api/immutadot/0.3/util.html#.using) has been removed for the same reasons as `chain()`:
- Imports all of immutadot's functions
- Difficult to extend

immutadot now has a [`get()`](https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.get) function that allows you to do the same:
immutadot now has a [`get()`](https://immutadot.zenika.com/api/immutadot/1.0/core.html#.get) function that allows you to do the same:

```diff
-import { using } from 'immutadot'
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
# Documentation

Latest API documentations for our different packages are available here:
- [immutadot](https://zenika-open-source.github.io/immutadot/api/immutadot)
- [immutadot-lodash](https://zenika-open-source.github.io/immutadot/api/immutadot-lodash/)
- [immutadot](https://immutadot.zenika.com/api/immutadot)
- [immutadot-lodash](https://immutadot.zenika.com/api/immutadot-lodash/)

Older API documentations :
- [immutadot 0.3](https://zenika-open-source.github.io/immutadot/api/immutadot/0.3)
- [immutadot 0.2](https://zenika-open-source.github.io/immutadot/api/immutadot/0.2)
- [immutadot 0.1](https://zenika-open-source.github.io/immutadot/api/immutadot/0.1)
- [immutadot 0.3](https://immutadot.zenika.com/api/immutadot/0.3)
- [immutadot 0.2](https://immutadot.zenika.com/api/immutadot/0.2)
- [immutadot 0.1](https://immutadot.zenika.com/api/immutadot/0.1)

Other ressources:
- [Getting started](./GETTING_STARTED.md)
Expand Down
10 changes: 5 additions & 5 deletions docs/api/immutadot-lodash/1.0/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ <h2 class="home-link"><a href="index.html">immutadot</a></h2><h3>Namespaces</h3>
// → { i18n: { languages: ['English', 'French', 'German', 'Spanish'] } }</code></pre><p>immutadot gives you a short and meaningful syntax to apply operations on immutable structures.</p>
<p><a href="https://badge.fury.io/js/immutadot"><img src="https://badge.fury.io/js/immutadot.svg" alt="npm version"></a>
<a href="https://npm.runkit.com/immutadot"><img src="https://badge.runkitcdn.com/immutadot.svg" alt="Try on RunKit"></a>
<a href="https://zenika-open-source.github.io/immutadot/api/immutadot"><img src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" alt="Documentation"></a></p>
<a href="https://immutadot.zenika.com/api/immutadot"><img src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" alt="Documentation"></a></p>
<p><a href="https://circleci.com/gh/zenika-open-source/immutadot"><img src="https://circleci.com/gh/zenika-open-source/immutadot.svg?style=shield&amp;circle-token=8b309750f5785783ec9fb4531ba097da60563beb" alt="CircleCI"></a>
<a href="https://codecov.io/gh/zenika-open-source/immutadot"><img src="https://codecov.io/gh/zenika-open-source/immutadot/branch/master/graph/badge.svg" alt="codecov"></a>
<h2><a href="https://github.com/zenika-open-source/immutadot/releases">1.0</a> is out 🎉</h2><p>If you were using a previous version of immutadot, check out the <a href="docs/MIGRATING_TO_1_0.md">migrating guide</a>.</p>
Expand All @@ -62,7 +62,7 @@ <h2>Installation</h2><p>immutadot is available on <a href="https://www.npmjs.com
<pre class="prettyprint source lang-shell"><code>$ npm install immutadot</code></pre><p>or you can directly download <a href="https://github.com/zenika-open-source/immutadot/releases">sources</a>.</p>
<h2>Usage</h2><p>ES modules:</p>
<pre class="prettyprint source lang-js"><code>import { set } from 'immutadot'</code></pre><p>CommonJS: </p>
<pre class="prettyprint source lang-js"><code>const { set } = require('immutadot')</code></pre><h3>Example</h3><p>Quickly set nested properties using <a href="https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.set">set()</a></p>
<pre class="prettyprint source lang-js"><code>const { set } = require('immutadot')</code></pre><h3>Example</h3><p>Quickly set nested properties using <a href="https://immutadot.zenika.com/api/immutadot/1.0/core.html#.set">set()</a></p>
<pre class="prettyprint source lang-js"><code>import { set } from 'immutadot'

const animals = {
Expand All @@ -78,8 +78,8 @@ <h2>Usage</h2><p>ES modules:</p>
<h2>Documentation</h2><h3>Getting started</h3><p>A fast overview of immutadot's features is available in the <a href="https://github.com/zenika-open-source/immutadot/blob/master/docs/GETTING_STARTED.md">Getting started</a> guide.</p>
<h3>API</h3><p>The detailed API documentations of the different packages are available here:</p>
<ul>
<li><a href="https://zenika-open-source.github.io/immutadot/api/immutadot">immutadot</a></li>
<li><a href="https://zenika-open-source.github.io/immutadot/api/immutadot-lodash/">immutadot-lodash</a></li>
<li><a href="https://immutadot.zenika.com/api/immutadot">immutadot</a></li>
<li><a href="https://immutadot.zenika.com/api/immutadot-lodash/">immutadot-lodash</a></li>
</ul>
<p>Looking for older versions API documentation? Links are available <a href="https://github.com/zenika-open-source/immutadot/blob/master/docs/README.md">here</a>.</p>
<h3>Migrating from 0.x versions</h3><p>If you were using a version of immutadot previous to 1.0, check out the <a href="docs/MIGRATING_TO_1_0.md">migrating guide</a>.</p>
Expand Down Expand Up @@ -116,7 +116,7 @@ <h2>Performances</h2><p>A <a href="https://github.com/zenika-open-source/immutad
</ul>
<h2>Our approach</h2><h3>Concise</h3><p><a href="https://mdn.io/JavaScript/Reference">ES2015+</a> new features are great to deal with arrays and objects. As data structures expand, the code you write to make data immutable gets bigger and less readable. immutadot uses the dot notation to address this issue.</p>
<h3>Interoperability</h3><p>immutadot uses plain JavaScript objects so you can access your data using standard ways. Moreover, it lets you freely enjoy your favorite libraries.</p>
<h3>Exhaustive and yet extensible</h3><p>immutadot comes with a large set of built-in utilities, mostly based on <a href="https://mdn.io/JavaScript/Reference">ES2015+</a>. You can also find a package called <a href="https://github.com/zenika-open-source/immutadot/tree/master/packages/immutadot-lodash">immutadot-lodash</a> with some of <a href="https://lodash.com/">lodash</a>'s utilities. You haven't found what you're looking for? Do it yourself with the <a href="https://zenika-open-source.github.io/immutadot/api/immutadot/1.0/core.html#.convert"><code>convert</code></a> feature.</p>
<h3>Exhaustive and yet extensible</h3><p>immutadot comes with a large set of built-in utilities, mostly based on <a href="https://mdn.io/JavaScript/Reference">ES2015+</a>. You can also find a package called <a href="https://github.com/zenika-open-source/immutadot/tree/master/packages/immutadot-lodash">immutadot-lodash</a> with some of <a href="https://lodash.com/">lodash</a>'s utilities. You haven't found what you're looking for? Do it yourself with the <a href="https://immutadot.zenika.com/api/immutadot/1.0/core.html#.convert"><code>convert</code></a> feature.</p>
<h3>Learning curve</h3><p>If you are already familiar with <a href="https://mdn.io/JavaScript/Reference">ES2015+</a> and <a href="https://lodash.com/">lodash</a> then you should be able to use immutadot quickly.</p>
<h2>Contributing</h2><p>We want contributing to immutadot to be fun, enjoyable, and educational for anyone, and everyone.</p>
<h3><a href="https://github.com/zenika-open-source/immutadot/blob/master/.github/CODE_OF_CONDUCT.md">Code of Conduct</a></h3><p>In the interest of fostering an open and welcoming environment, we have adopted a Code of Conduct that we expect project participants to commit to. Please read the <a href="https://github.com/zenika-open-source/immutadot/blob/master/.github/CODE_OF_CONDUCT.md">full text</a> so that you can understand what behavior will and will not be tolerated.</p>
Expand Down

0 comments on commit 66efce3

Please sign in to comment.