Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix spelling mistakes #326

Merged
merged 3 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/combine-events/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ const target = combineEvents({

### Returns

- `target` — When `target` option is not defined, will return new event with the same shape as `events`, otherwise `target` unit will returns
- `target` — When `target` option is not defined, will return new event with the same shape as `events`, otherwise `target` unit will return

### Example

Expand Down
4 changes: 2 additions & 2 deletions src/debug/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ debug.unregisterAllScopes();

### Initial store state

`debug($store)` always immediatly prints current state of the store, but this state can be different in different scopes.
It is recommened to register scopes explicitly, since `debug` will print current state of the store in every known scope:
`debug($store)` always immediately prints current state of the store, but this state can be different in different scopes.
It is recommended to register scopes explicitly, since `debug` will print current state of the store in every known scope:

```ts
const $count = createStore(0);
Expand Down
4 changes: 2 additions & 2 deletions src/delay/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Use `delay({ source, timeout })` with patronum < 2.1.0
### Motivation

This overload allows you to read timeout from another store.
It is useful when you writing music editor and need dynamic delay for your events.
It is useful when you write music editor and need dynamic delay for your events.

### Formulae

Expand Down Expand Up @@ -243,7 +243,7 @@ update('Hello');
### Motivation

This overload allows you to read timeout from another store.
It is useful when you writing music editor and need dynamic delay for your events.
It is useful when you write music editor and need dynamic delay for your events.

### Formulae

Expand Down
2 changes: 1 addition & 1 deletion src/in-flight/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ loadSecond();
### Motivation

This overload allows to count effects in flight of the whole domain.
It is usef when you want to show loading state of the whole application.
It is useful when you want to show loading state of the whole application.

### Formulae

Expand Down
4 changes: 2 additions & 2 deletions src/pending/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ $inProcess = pending({ effects: [fx1, fx2], of: Strategy });

1. `effects` `(Array<Effect<any, any, any>>)` - array of any effects
1. `of` `("some" | "every")` — Optional. Select strategy of combining pendings
of differents effects. Default `"some"`
of different effects. Default `"some"`

:::note since
The `of` argument was added since patronum 1.1.0
Expand Down Expand Up @@ -127,7 +127,7 @@ $inProcess = pending({ domain, of: Strategy });

1. `domain` `(Domain)` - Effector domain with at least one effect
1. `of` `("some" | "every")` — Optional. Select strategy of combining pendings
of differents effects. Default `"some"`
of different effects. Default `"some"`

### Returns

Expand Down
6 changes: 3 additions & 3 deletions src/spread/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ source = spread({ field: target, ... })
- When `source` is triggered with **object**, extract `field` from data, and trigger `target`
- `targets` can have multiple properties
- If the `source` was triggered with non-object, nothing would be happening
- If `source` is triggered with object but without propertpy `field`, target for this `field` will not be triggered
- If `source` is triggered with object but without property `field`, target for this `field` will not be triggered

### Arguments

Expand Down Expand Up @@ -117,7 +117,7 @@ spread({ source, targets: { field: target, ... } })
- When `source` is triggered with **object**, extract `field` from data, and trigger `target`
- `targets` can have multiple properties
- If the `source` was triggered with non-object, nothing would be happening
- If `source` is triggered with object but without propertpy `field`, target for this `field` will not be triggered
- If `source` is triggered with object but without property `field`, target for this `field` will not be triggered

### Arguments

Expand Down Expand Up @@ -202,7 +202,7 @@ source = spread({ targets: { field: target, ... } })
- When `source` is triggered with **object**, extract `field` from data, and trigger `target`
- `targets` can have multiple properties
- If the `source` was triggered with non-object, nothing would be happening
- If `source` is triggered with object but without propertpy `field`, target for this `field` will not be triggered
- If `source` is triggered with object but without property `field`, target for this `field` will not be triggered

### Arguments

Expand Down
2 changes: 1 addition & 1 deletion src/time/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ $time = time({ clock, getNow, initial });
### Returns

`$time: Store<Time>` — Store contains unix timestamp snapshot, updates when `clock` triggers.
If `getNow` is overrided, contains value this function returns.
If `getNow` is overridden, contains value this function returns.
By default, it is `number`.
Initialized with `initial`, by default, it is `Date.now()`

Expand Down
Loading