import ResourceProxy from '@mapcreator/api/src/proxy/ResourceProxy.js'

protected class | source

ResourceProxy

Proxy for accessing resource. This will make sure that they are properly wrapped before the promise resolves.

Method Summary

Public Methods
public	get(id: Number \| String \| Object, deleted: String): CancelablePromise<ResourceBase> Get target resource
public	select(id: Number \| String): ResourceBase Select target resource without obtaining data

From class SimpleResourceProxy
public get	Target: Class<ResourceBase>: * Target to wrap results in
public get	api: Mapcreator: * Get api instance
public get	baseUrl: string: * Proxy target url
public	list(params: Number \| Object \| RequestParameters): CancelablePromise<PaginatedResourceListing> List target resource
public	lister(parameters: object \| RequestParameters, maxRows: number): ResourceLister Get the resource lister
public	new(data: Object<String, *>): ResourceBase Build a new instance of the target

Get target resource

Name	Type	Attribute	Description
id	Number \| String \| Object	optional default:	The resource id to be requested
deleted	String	optional default: null	Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all

Target resource

If the api returns errors

Select target resource without obtaining data

Name	Type	Attribute	Description
id	Number \| String	optional default:	Resource id

Empty target resource

api.users.select('me').colors().then(doSomethingCool);