Interface Client

Client interface defines the available API methods called inside the admin components.

You can implement custom strategies on the Request signature here defined, in order to integrate with custom endpoints, i.e. GraphQL or localStorage.

todo

Enhance type definitions in order to include FetchApiResult status. Actually there is no way to know if a request was successful or not; maybe we need to add Generic to FetchApiResult, so we can do something like (..) => Promise<FetchResult<ModelRecord>> where ModelRecord will be response.data type.

Hierarchy

Implemented by

Index

Methods

addToRelation

create

createRelated

delete

deleteRelated

find

loadAll

loadAllRelated

removeFromRelation

save

saveRelated

update

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc