Skip to content

Commit

Permalink
Docs for props, links, embedded
Browse files Browse the repository at this point in the history
  • Loading branch information
passy committed May 10, 2013
1 parent 74a1e47 commit 9e0a58a
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,11 @@ A boolean indicating whether the resource has been completely loaded or is
potentially incomplete. Resources retrieved via `fetched()` and embedded
resources are considered as fully loaded.

### Resource#links

An object, containing links with their rel as key. Links are resources, lazily
created on access or arrays of links.

### Resource#link(rel[, params])

Creates a new link resource identified by the given `rel` and expands the link
Expand All @@ -284,6 +289,15 @@ var link = api.link('me', { username: 'sindresorhus' });
assert(link.url() === 'http://example.com/users/sindresorhus');
```

### Resource#embedded

An object containing all embedded resource, created lazily on access.

### Resources#props

An object containing all properties on the current resource. This includes all
properties of the resource, except `_links` and `_embedded`.

## FAQ

### Promises?
Expand Down

0 comments on commit 9e0a58a

Please sign in to comment.