Skip to content

Latest commit

 

History

History
136 lines (133 loc) · 5.71 KB

api.md

File metadata and controls

136 lines (133 loc) · 5.71 KB

API

Functions

createApi(spec, queryConfig, settings?)

Creates api instance object, with the same structure as given spec.

Arguments:

  • spec: Spec - Api definition.
  • queryConfig: QueryConfig - Api request configuration, could be ovverrided in spec entry.
  • settings?: Settings - Api settings.

Returns: Api

createMiddleware(api, anotherApi?, ...)

Creates middleware for listening request actions and fetching data from server. Accepts multiple api instances.

Arguments:

  • api: Api - Api instance object.

Returns: Redux middleware function.

createReducer(api)

Creates reducer for given api instance. Should be mounted at state.api path unless selector option is specified at Settings.

Arguments:

  • api: Api - Api instance object.

Returns: Redux reducer.

Types

Spec

Api spec object. Could have any level of nesting. Contains SpecEntry objects as values.

SpecEntry

Api spec entry object. Contains description of api request.

Fields:

  • path: string - Url path of api call. Accepts params in format :[param_name].
  • method: string - Http method of request.
  • config?: QueryConfig - Request configuration. Overrides default config.

QueryConfig

Api request configuration.

Fields:

  • endpoint: string - Api endpoint.

Settings

Api instance settings.

Fields:

  • context?: string = "" - Prefix, which will be added in the beginning of action types in the specific api.
  • selector?: function = (state) => state.api - Selector, returning api reducer.

Api

Api instance object. Contains ApiEntry objects as values. Has the same structure as it's Spec.

ApiEntry

Api entry object. Contains all needed data for making and handling api request.

Fields:

  • select: ApiEntry.select - Returns redux selector according given key.
  • type: ApiEntry.type - Returns action type according given key.
  • actions: Actions - Object of redux action creators.
  • reducer: ApiEntry.reducer - Api entry reducer. Used internally in the library and in the enhancer API.
  • fetch: ApiEntry.fetch - Function, used to making api requests. Used internally in the library and in the enhancer API.

ApiEntry.select(key)

Arguments:

  • key: 'data' | 'isFetching' | 'lastUpdated' | 'error' - Api entry state key.

ApiEntry.type(key)

Arguments:

  • key: 'request' | 'success' | 'failure' - Action type key.

ApiEntry.reducer(state, action)

Arguments:

  • state: State - Api entry state object.
  • action: Object - Redux action.

ApiEntry.fetch(onSuccess, onFailure, payload?)

Arguments:

  • onSuccess: function - Callback, which will be called when request succeeded.
  • onFailure: function - Callback, which will be called when request failed.
  • payload?: RequestAction.payload - Request action payload object.

Actions

Async actions creators object.

Fields:

Actions.request(payload?)

Arguments:

Actions.success(payload)

Arguments:

Actions.failure(payload)

Arguments:

RequestAction

Request action object.

Fields:

  • type: string - Action type, has format like "[prefix/[path]/request]".
  • payload?: RequestAction.payload - Request action payload data.

RequestAction.payload

Fields:

  • params?: Object - Params of api request, should correspond to params, defined in SpecEntry path.
  • body?: any - Request body data.

SuccessAction

Success action object.

Fields:

  • type: string - Action type, has format like "[prefix/[path]/success]".
  • payload?: SuccessAction.payload - Success action payload data.

SuccessAction.payload

Fields:

FailureAction

Failure action object.

Fields:

  • type: string - Action type, has format like "[prefix/[path]/failure]".
  • payload?: FailureAction.payload - Failure action payload data.

FailureAction.payload

  • meta: ResponseMeta - Object, containing meta data of response.
  • message: string - Error message.
  • request?: RequestAction.payload - Payload of request action.
  • body?: any - Response body data.

ResponseMeta

Meta data of response.

Fields:

  • status: number - Response status code.
  • receivedAt: number - Response timestamp.

State

Api entry state object.

Fields

  • isFetching: boolean - Value, determining whether data is fetching from server or not.
  • request?: RequestAction.payload - Payload of request action.
  • data?: any - Response body data.
  • lastUpdated?: number - Timestamp of last request.
  • error?: string - Error message.