From 7883987542641fd192d690f2eff9ab8a49055ac9 Mon Sep 17 00:00:00 2001 From: Bill Criswell Date: Wed, 30 Mar 2016 01:12:00 -0400 Subject: [PATCH 1/2] added Array Extension Methods to the API page --- src/api/index.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/src/api/index.md b/src/api/index.md index 1b02bc416e..8072c369b5 100644 --- a/src/api/index.md +++ b/src/api/index.md @@ -2161,3 +2161,39 @@ type: api }) {% endraw %} + +## Array Extension Methods + +### array.$set(index, value) + +- **Arguments** + - `{Number} index` + - `{*} value` + +- **Usage** + + Set an element in the array to a value by index and triggers view updates. + + ``` js + vm.animals.$set(0, { name: 'Aardvark' }) + ``` + +- **See also:** [Mutation Methods](/guide/list.html#Mutation-Methods) + +### array.$remove(indexOrReference) + +- **Arguments** + - `{Number | Reference} indexOrReference` + +- **Usage** + + Remove an element from an array by index or reference and triggers view updates. + + ``` js + vm.animals.$remove(0) + // or + var aardvark = vm.animals[0] + vm.animals.$remove(aardvark) + ``` + +- **See also:** [Mutation Methods](/guide/list.html#Mutation-Methods) \ No newline at end of file From a42cc96897af4ac83eb2a9d914456e916258e5f2 Mon Sep 17 00:00:00 2001 From: Bill Criswell Date: Wed, 30 Mar 2016 07:40:39 -0400 Subject: [PATCH 2/2] remove index mention for remove, fixed a typo --- src/api/index.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/api/index.md b/src/api/index.md index 8072c369b5..a8dabfe2e2 100644 --- a/src/api/index.md +++ b/src/api/index.md @@ -2172,7 +2172,7 @@ type: api - **Usage** - Set an element in the array to a value by index and triggers view updates. + Set an element in the array to a value by index and trigger view updates. ``` js vm.animals.$set(0, { name: 'Aardvark' }) @@ -2180,18 +2180,16 @@ type: api - **See also:** [Mutation Methods](/guide/list.html#Mutation-Methods) -### array.$remove(indexOrReference) +### array.$remove(reference) - **Arguments** - - `{Number | Reference} indexOrReference` + - `{Reference} reference` - **Usage** - Remove an element from an array by index or reference and triggers view updates. + Remove an element from an array by reference and trigger view updates. ``` js - vm.animals.$remove(0) - // or var aardvark = vm.animals[0] vm.animals.$remove(aardvark) ```