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

Constructors

constructor

Properties

actionDetail actionName? base cache? cacheEnable getContext http injector mapItem? name

Accessors

isAction

Methods

cacheReset create destroy flex getAction getEndpoint getEndpointSingle list retrieve update upload

Constructors

constructor

Properties

ReadonlyactionDetail

actionDetail: boolean = false

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

Optional ReadonlyactionName

actionName?: string

Action name in case of action API.

Readonlybase

base: string

API base URL (default is CRUD_BASE).

Set this to override the injection token value.

Private Optionalcache

cache?: LT

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

See

cacheEnable

ReadonlycacheEnable

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

ReadonlygetContext

getContext: GetContextFunction = ...

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

Private Readonlyhttp

http: HttpClient

Must be set in API service before usage.

Private Readonlyinjector

injector: Injector

Injector instance to get Angular injections.

Optional ReadonlymapItem

mapItem?: MapItemFunction<any>

Method that changes the data from API response.

Readonlyname

name: string

API endpoint.

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

    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>,
            "name" | "injector" | "actionName" | "actionDetail",
        >,
    ): Crud<AT, ATL>

    Create an action view of this Crud.

    Type Parameters

    Parameters

    • name: string

      Action name.

    • isDetail: boolean

      Whether action is detail.

    • options: Omit<CrudInit<AT, ATL>, "name" | "injector" | "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

    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>

Settings

Member Visibility

On This Page

ConfigurationAction CrudGeneric Type Params
Constructors
Properties
Accessors
Methods