ModelConfig

A decorator used for configuring a model. It takes one argument, ModelOptions. The argument interface and the default values can be checked here.

Options

• type: string

  • unique name of the model class

• endpoint

  • sets the model endpoint which is used for building request URLs
  • either this property has to be set or the endpoint getter on a model has to be implemented

• halDocumentClass: HalDocumentConstructor<HalModel>

  • optional
  • if set, this class will be used instead of HalDocument class

• network: NetworkConfig

  • optional
  • overrides the network config specified on a datastore level DatastoreConfig

Example

import { HalModel, ModelConfig } from 'ngx-hal';

@ModelConfig({
  type: 'User',
  endpoint: 'consumer'
})
export class User extends HalModel {}

In the case above, fetching a list of users will trigger a request to mydomain.com/consumer. In the case the endpoint property is not specified in the ModelConfig decorator, the request will be made to mydomain.com/User.