Class Crud<T, LT>

CRUD API model for a typical DRF ModelViewSet.

Configuration

To configure Crud, injection tokens must be set. Tokens: CRUD_HTTP_CLIENT CRUD_BASE

Action Crud

From an existing Crud instance

Use the getAction method to create a new instance of Crud but specific for your action.

New Crud instance

For action views, you muse set Crud.actionName.

For detail action views, you must provide Crud.actionDetail and pass the parent PK in every method for API calls.

Generic Type Params

T is the type of data. LT is the type of data returned in list.

Type Parameters

T
LT = ApiResponse<T>

Index

Constructors

constructor

new Crud<T, LT = ApiResponse<T>>(data: CrudInit<T, LT>): Crud<T, LT>
Type Parameters
- T
- LT = ApiResponse<T>
Parameters
- data: CrudInit<T, LT>
Returns Crud<T, LT>

Properties

`Readonly`actionDetail

actionDetail: boolean = false

Is this a detailed action (in case of action API)? (default is false).

`Optional` `Readonly`actionName

actionName?: string

Action name in case of action API.

`Readonly`base

base: string

API base URL (default is CRUD_BASE).

Set this to override the injection token value.

`Private` `Optional`cache

cache?: LT

Last cache value stored for list action. Works only when cache is enabled for this crud.

See

cacheEnable

`Readonly`cacheEnable

cacheEnable: boolean = false

Enable cache for list action? (default is false).

Cache is reset automatically when making these API calls:

create
update
destroy

See

cache
cacheReset
list

`Readonly`getContext

getContext: GetContextFunction = ...

Method that returns an HTTP context instance to use for making API calls.

`Private` `Readonly`http

http: HttpClient

Must be set in API service before usage.

`Private` `Readonly`injector

injector: Injector

Injector instance to get Angular injections.

`Optional` `Readonly`mapItem

mapItem?: MapItemFunction<any>

Method that changes the data from API response.

`Readonly`name

name: string

API endpoint.

`Readonly`onRequest

onRequest: EventEmitter<CrudRequest> = ...

Triggered when an API call is made.

Accessors

isAction

get isAction(): boolean
Returns boolean
true if this is an action API.

Methods

cacheReset

cacheReset(): void
Clear stored cache.

Returns void
See
cacheEnable

create

create(payload?: Payload<T>, parentPk?: PK): Observable<T>
Create a new object. ModelViewSet create action.
Parameters
- Optionalpayload: Payload<T>
- OptionalparentPk: PK
Returns Observable<T>

destroy

destroy(pk: PK, parentPk?: PK): Observable<void>
Delete a single object. ModelViewSet delete action.
Parameters
- pk: PK
- OptionalparentPk: PK
Returns Observable<void>

flex

flex(
    fields: (string | keyof T)[],
    params?: GetParams,
    ignoreCache?: boolean,
    parentPk?: PK,
): Observable<LT>
Trigger list action with fields needed.
Parameters
- fields: (string | keyof T)[]
  Fields to include in the API response.
- Optionalparams: GetParams
  Rest of the query params (optional).
- OptionalignoreCache: boolean
  Flag to ignore the cache (default is false).
- OptionalparentPk: PK
  Parent PK in case of action view (optional).
Returns Observable<LT>
See
cacheEnable

getAction

getAction<AT = T, ATL = ApiResponse<AT>>(
    name: string,
    isDetail: boolean,
    options?: Omit<
        CrudInit<AT, ATL>,
        "injector" | "name" | "actionName" | "actionDetail",
    >,
): Crud<AT, ATL>
Create an action view of this Crud.
Type Parameters
- AT = T
- ATL = ApiResponse<AT>
Parameters
- name: string
  Action name.
- isDetail: boolean
  Whether action is detail.
- options: Omit<CrudInit<AT, ATL>, "injector" | "name" | "actionName" | "actionDetail"> = {}
  Other Crud options.
Returns Crud<AT, ATL>
new Crud instance but action.

getEndpoint

getEndpoint(parentPk?: PK): string
Parameters
- OptionalparentPk: PK
  PK of parent in case of action.
Returns string
Full API endpoint URL.

Throws
Error when parentPk is not provided in case of detail action.

getEndpointSingle

getEndpointSingle(pk: PK, parentPk?: PK): string
Parameters
- pk: PK
  PK of the object.
- OptionalparentPk: PK
  PK of parent in case of action.
Returns string
Full API endpoint URL of a single object.

Throws
Error when parentPk is not provided in case of detail action.

list

list(params?: GetParams, ignoreCache?: boolean, parentPk?: PK): Observable<LT>
Get list of objects. ModelViewSet list action.
Parameters
- Optionalparams: GetParams
  HTTP query params.
- OptionalignoreCache: boolean
  Ignore cached value (if cache is enabled) (default is false).
- OptionalparentPk: PK
  PK of parent object (if this is an action Crud) (optional).
Returns Observable<LT>

retrieve

retrieve(pk: PK, parentPk?: PK): Observable<T>
Get a single object. ModelViewSet retrieve action.
Parameters
- pk: PK
- OptionalparentPk: PK
Returns Observable<T>

update

update(pk: PK, payload?: Payload<T>, parentPk?: PK): Observable<T>
Update a single object. ModelViewSet update action.
Parameters
- pk: PK
- Optionalpayload: Payload<T>
- OptionalparentPk: PK
Returns Observable<T>

upload

upload(file: File, payload?: FormData, parentPk?: PK): Observable<T>
Create a new file upload object.

Same as create but with FormData as payload.
Parameters
- file: File
  File instance to append to the form. Uses name for the filename property of append.
- payload: FormData = ...
  Form data instance (defaults to new FormData()).
- OptionalparentPk: PK
  PK of the parent in case of detail action CRUD instance.
Returns Observable<T>

Class Crud<T, LT>

Configuration

Action Crud

From an existing Crud instance

New Crud instance

Generic Type Params

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Crud<T, LT>

Properties

ReadonlyactionDetail

Optional ReadonlyactionName

Readonlybase

Private Optionalcache

See

ReadonlycacheEnable

See

ReadonlygetContext

Private Readonlyhttp

Private Readonlyinjector

Optional ReadonlymapItem

Readonlyname

ReadonlyonRequest

Accessors

isAction

Returns boolean

Methods

cacheReset

Returns void

See

create

Parameters

Returns Observable<T>

destroy

Parameters

Returns Observable<void>

flex

Parameters

Returns Observable<LT>

See

getAction

Type Parameters

Parameters

Returns Crud<AT, ATL>

getEndpoint

Parameters

Returns string

Throws

getEndpointSingle

Parameters

Returns string

Throws

list

Parameters

Returns Observable<LT>

retrieve

Parameters

Returns Observable<T>

update

Parameters

Returns Observable<T>

upload

Parameters

Returns Observable<T>

Settings

On This Page

`Readonly`actionDetail

`Optional` `Readonly`actionName

`Readonly`base

`Private` `Optional`cache

`Readonly`cacheEnable

`Readonly`getContext

`Private` `Readonly`http

`Private` `Readonly`injector

`Optional` `Readonly`mapItem

`Readonly`name

`Readonly`onRequest