Skip to content

Commit

Permalink
Update docs: update param is not optional
Browse files Browse the repository at this point in the history
  • Loading branch information
rmunn committed Sep 27, 2021
1 parent a7e2a61 commit ef6e407
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions site/content/docs/03-run-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ This makes it possible to wrap almost any other reactive state handling library
store = writable(value?: any)
```
```js
store = writable(value?: any, start?: (set: (value: any) => void, update?: (fn: any => any) => void) => () => void)
store = writable(value?: any, start?: (set: (value: any) => void, update: (fn: any => any) => void) => () => void)
```

---
Expand All @@ -295,7 +295,7 @@ count.update(n => n + 1); // logs '2'

---

If a function is passed as the second argument, it will be called when the number of subscribers goes from zero to one (but not from one to two, etc). That function will be passed a `set` function which changes the value of the store, and optionally an `update` function which works like the `update` method on the store, taking a callback to calculate the store's new value from its old value. It must return a `stop` function that is called when the subscriber count goes from one to zero.
If a function is passed as the second argument, it will be called when the number of subscribers goes from zero to one (but not from one to two, etc). That function will be passed a `set` function which changes the value of the store, and an `update` function which works like the `update` method on the store, taking a callback to calculate the store's new value from its old value. It must return a `stop` function that is called when the subscriber count goes from one to zero.

```js
import { writable } from 'svelte/store';
Expand All @@ -319,7 +319,7 @@ Note that the value of a `writable` is lost when it is destroyed, for example wh
#### `readable`

```js
store = readable(value?: any, start?: (set: (value: any) => void) => () => void)
store = readable(value?: any, start?: (set: (value: any) => void, update: (fn: any => any) => void) => () => void)
```

---
Expand Down Expand Up @@ -356,13 +356,13 @@ const ticktock = readable(null, (set, update) => {
store = derived(a, callback: (a: any) => any)
```
```js
store = derived(a, callback: (a: any, set: (value: any) => void, update?: (fn: any => any) => void) => void | () => void, initial_value: any)
store = derived(a, callback: (a: any, set: (value: any) => void, update: (fn: any => any) => void) => void | () => void, initial_value: any)
```
```js
store = derived([a, ...b], callback: ([a: any, ...b: any[]]) => any)
```
```js
store = derived([a, ...b], callback: ([a: any, ...b: any[]], set: (value: any) => void, update?: (fn: any => any) => void) => void | () => void, initial_value: any)
store = derived([a, ...b], callback: ([a: any, ...b: any[]], set: (value: any) => void, update: (fn: any => any) => void) => void | () => void, initial_value: any)
```

---
Expand Down

0 comments on commit ef6e407

Please sign in to comment.