Skip to content

Commit 7ebae96

Browse files
committed
update ractive.get() docs to include new default behavior and options
1 parent 87a228f commit 7ebae96

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

docs/0.8/ractive.get().md.hbs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
---
22
title: ractive.get()
33
---
4-
> ### ractive.get( keypath )
4+
> ### ractive.get( keypath[, options ] )
55
> Returns the value at `keypath` (see {{{createLink 'Keypaths'}}})
66

7-
> ### ractive.get()
8-
> Returns a shallow copy of all data (the equivalent of `ractive.get('')`). This does not include {{{createLink 'computed properties' 'Computed Properties' }}}, but it does include any mappings if `ractive` happens to be a component instance with mappings.
7+
> > #### **keypath** *`String`*
8+
> > The keypath for which to return a value.
9+
> > #### **options** *`Object`*
10+
> > Optional values that affect the returned value:
11+
> > * **virtual** *`Boolean`* - default `false` - if `true`, the returned value will be a deep POJO clone of the target keypath with any nested links copied in from their sources.
12+
13+
> ### ractive.get([ options ])
14+
> Returns a copy of all of the data and, by default, any computations and linked or mapped data copied into the tree.
15+
16+
> > #### **options** *`Object`*
17+
> > Optional values that affect the returned value:
18+
> > * **virtual** *`Boolean`* - default `true` - if `true`, the returned value will be a deep POJO clone of the root model, including computations, with any nested links copied in from their sources. If `false`, the raw root object will be returned.

docs/edge/ractive.get().md.hbs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
---
22
title: ractive.get()
33
---
4-
> ### ractive.get( keypath )
4+
> ### ractive.get( keypath[, options ] )
55
> Returns the value at `keypath` (see {{{createLink 'Keypaths'}}})
66

7-
> ### ractive.get()
8-
> Returns a shallow copy of all data (the equivalent of `ractive.get('')`). This does not include {{{createLink 'computed properties' 'Computed Properties' }}}, but it does include any mappings if `ractive` happens to be a component instance with mappings.
7+
> > #### **keypath** *`String`*
8+
> > The keypath for which to return a value.
9+
> > #### **options** *`Object`*
10+
> > Optional values that affect the returned value:
11+
> > * **virtual** *`Boolean`* - default `false` - if `true`, the returned value will be a deep POJO clone of the target keypath with any nested links copied in from their sources.
12+
13+
> ### ractive.get([ options ])
14+
> Returns a copy of all of the data and, by default, any computations and linked or mapped data copied into the tree.
15+
16+
> > #### **options** *`Object`*
17+
> > Optional values that affect the returned value:
18+
> > * **virtual** *`Boolean`* - default `true` - if `true`, the returned value will be a deep POJO clone of the root model, including computations, with any nested links copied in from their sources. If `false`, the raw root object will be returned.

0 commit comments

Comments
 (0)