docs: fix incorrect readable store

Changed in f3cb540ce6 (first brought up in #2296), but the docs got missed.
pull/2366/head
Pat Cavit 6 years ago committed by GitHub
parent 6e32ffd990
commit e93eb6fbb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -224,25 +224,25 @@ const unsubscribe = count.subscribe(value => {
unsubscribe(); // logs 'no more subscribers' unsubscribe(); // logs 'no more subscribers'
``` ```
* `store = readable((set: (value: any) => void) => () => void)` * `store = readable(value: any)`
* `store = readable((set: (value: any) => void) => () => void, value: any)` * `store = readable(value: any, (set: (value: any) => void) => () => void)`
--- ---
Creates a store whose value cannot be set from 'outside'. Instead, the function passed to `readable`, which is called when the subscriber count goes from zero to one, must call the provided `set` value. It must return a function that is called when the subscriber count goes from one to zero. Creates a store whose value cannot be set from 'outside', the first argument is the store's initial value.
If a second argument is provided, it becomes the store's initial value. The second argument to `readable` can be a function which is called when the subscriber count goes from zero to one. That function will be passed a `set` function and can change the value of the store by calling `set` with an updated value. It must return a function that is called when the subscriber count goes from one to zero.
```js ```js
import { readable } from 'svelte/store'; import { readable } from 'svelte/store';
const time = readable(set => { const time = readable(new Date(), set => {
const interval = setInterval(() => { const interval = setInterval(() => {
set(new Date()); set(new Date());
}, 1000); }, 1000);
return () => clearInterval(interval); return () => clearInterval(interval);
}, new Date()); });
``` ```
* `store = derive(a, callback: (a: any) => any)` * `store = derive(a, callback: (a: any) => any)`

Loading…
Cancel
Save