Skip to content

Commit 33db9b8

Browse files
authored
fix: keyed readme example misses keyfn (#828)
2 parents 0a51c8b + a56e80f commit 33db9b8

File tree

2 files changed

+30
-23
lines changed

2 files changed

+30
-23
lines changed

.changeset/gentle-eyes-lead.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@solid-primitives/keyed": patch
3+
---
4+
5+
docs: add missing keyfn to example

packages/keyed/README.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -47,30 +47,32 @@ The `keyArray` primitive takes 4 arguments:
4747
- `options` - a fallback for when the input list is empty or missing _(Optional)_
4848

4949
```ts
50-
const mapped = keyArray(source, (model, index) => {
51-
const [name, setName] = createSignal(model().name);
52-
const [description, setDescription] = createSignal(model().description);
53-
54-
createComputed(() => {
55-
setName(model().name);
56-
setDescription(model().description);
50+
const mapped = keyArray(source,
51+
(model) => model.id,
52+
(model, index) => {
53+
const [name, setName] = createSignal(model().name);
54+
const [description, setDescription] = createSignal(model().description);
55+
56+
createComputed(() => {
57+
setName(model().name);
58+
setDescription(model().description);
59+
});
60+
61+
return {
62+
id: model.id,
63+
get name() {
64+
return name();
65+
},
66+
get description() {
67+
return description();
68+
},
69+
get index() {
70+
return index();
71+
},
72+
setName,
73+
setDescription,
74+
};
5775
});
58-
59-
return {
60-
id: model.id,
61-
get name() {
62-
return name();
63-
},
64-
get description() {
65-
return description();
66-
},
67-
get index() {
68-
return index();
69-
},
70-
setName,
71-
setDescription,
72-
};
73-
});
7476
```
7577

7678
Notice that both the value and index arguments are signals. Items are identified only by keys, it means that the items could be copied, replaced, changed, but as long as the key is the same, `keyArray` will treat it as the same item.

0 commit comments

Comments
 (0)