API Docs for: 0.2.1
Show:

RelatedProxyUtil Class

Defined in: addon/utils/related-proxy.js:11
Module: utils
Parent Module: ember-jsonapi-resources

Utility for creating promise proxy objects for related resources

Methods

createProxy

(
  • resource
  • kind
)
PromiseProxy | ObjectProxy | ArrayProxy

Defined in addon/utils/related-proxy.js:51

Proxy for the requested relation, resolves w/ content from fulfilled promise

Parameters:

  • resource Resource
  • kind String

    'toMany' or 'toOne'

Returns:

PromiseProxy | ObjectProxy | ArrayProxy:

proxy instance, new resource uses mock relations

init

()

Defined in addon/utils/related-proxy.js:20

Checks for required relationship property

linksPath

(
  • relation
)
String

Defined in addon/utils/related-proxy.js:181

Parameters:

  • relation String

Returns:

String:

path to the related link

promiseFromCache

(
  • resource
  • relation
  • service
)
Promise | Null

Defined in addon/utils/related-proxy.js:138

Lookup relation from service cache and pomisify result

Parameters:

  • resource Resource
  • relation String
  • service Object

Returns:

Promise | Null:

proxyResolution

(
  • resource
)
PromiseProxy

Defined in addon/utils/related-proxy.js:99

Parameters:

  • resource Proxy

Returns:

PromiseProxy:

proxy

proxySetup

(
  • resource
  • kind
  • proxyFactory
)
PromiseProxy

Defined in addon/utils/related-proxy.js:76

Parameters:

  • resource Resource
  • kind String

    'toMany' or 'toOne'

  • proxyFactory Ember.ObjectProxy | Ember.ArrayProxy

Returns:

PromiseProxy:

proxy

proxyUrl

(
  • resource
  • relation
)
PromiseProxy

Defined in addon/utils/related-proxy.js:121

Proxy url to fetch for the resource's relation

Parameters:

Returns:

PromiseProxy:

proxy

serviceCacheLookup

(
  • service
  • data
)
Resource | Undefined

Defined in addon/utils/related-proxy.js:166

Lookup data in service cache

Parameters:

  • service Object
  • data Object

Returns:

Resource | Undefined:

Properties

resource

String

Defined in addon/utils/related-proxy.js:33

The name of the relationship

type

String

Defined in addon/utils/related-proxy.js:42

The name of the type of resource