Home Manual Reference Source
public class | source

CrudBase

Extends:

ResourceBase → CrudBase

Indirect Subclass:

Dimension, Font, Svg

Base of all resource items that support Crud operations

Constructor Summary

Public Constructor
public

constructor(api: Maps4News, data: Object<String, *>)

Method Summary

Public Methods
public

async delete(updateSelf: Boolean): Promise<CrudBase>

Delete item

public

async restore(updateSelf: Boolean): Promise<CrudBase>

Restore item

public

Save item.

Protected Methods
protected

Build data for create operation

Inherited Summary

From class ResourceBase
public static get

Returns if the resource is readonly

public static get abstract

Resource name

public static get

Resource path template

public static get

Returns the url key of the resource

protected static get

Protected read-only fields

public get

Get api instance

public set

api(value: Maps4News)

Set the api instance

public get

Auto generated Resource base url

public get

List fields that contain object data

public get

If the resource can be owned by an organisation

public get

url: string: *

Auto generated resource url

public

Clone the object

public

async refresh(updateSelf: Boolean): Promise<ResourceBase>

Refresh the resource by requesting it from the server again

public

reset(fields: Array<string> | string | null)

Resets model instance to it's original state

public

Clean up instance and commit all changes locally.

public

static(Target: string | function, Constructor: function, seedData: Object<string, *>): SimpleResourceProxy

Static proxy generation

public

toObject(camelCaseKeys: boolean): {}

Transform instance to object

public

String representation of the resource, similar to Python's repr

protected

Macro for resource listing

protected

Moves new fields to this._properties and turns them into a getter/setter

Public Constructors

public constructor(api: Maps4News, data: Object<String, *>) source

Override:

ResourceBase#constructor

Params:

NameTypeAttributeDescription
api Maps4News

Api instance

data Object<String, *>

Item data

Public Methods

public async delete(updateSelf: Boolean): Promise<CrudBase> source

Delete item

Params:

NameTypeAttributeDescription
updateSelf Boolean
  • optional
  • default: true

Update current instance (set the deletedAt property)

Return:

Promise<CrudBase>

Current instance

Throw:

ApiError

ValidationError

public async restore(updateSelf: Boolean): Promise<CrudBase> source

Restore item

Params:

NameTypeAttributeDescription
updateSelf Boolean
  • optional
  • default: true

Update current instance (unset the deletedAt property)

Return:

Promise<CrudBase>

New restored instance

Throw:

ApiError

ValidationError

public save(): Promise<CrudBase> source

Save item. This will create a new item if id is unset

Return:

Promise<CrudBase>

Current instance

Throw:

ApiError

ValidationError

Protected Methods

protected _buildCreateData(): Object<String, *> source

Build data for create operation

Return:

Object<String, *>

Create data