Class Model<T, S>

constructor

• new Model<T = any, S = ModelSetOptions>(
      attributes?: Partial<T>,
      options?: any,
  ): Model<T, S>

  Type Parameters

  • T = any
  • S = ModelSetOptions

  Parameters

  • Optionalattributes: Partial<T>
  • Optionaloptions: any

  Returns Model<T, S>

attributes

changed

cid

cidPrefix

collection

id

idAttribute

url

urlRoot

validationError

chain

• chain(): any

  Returns any

changedAttributes

• changedAttributes(attributes?: any): any

  Return an object containing all the attributes that have changed, or false if there are no changed attributes. Useful for determining what parts of a view need to be updated and/or what attributes need to be persisted to the server. Unset attributes will be set to undefined. You can also pass an attributes object to diff against the model, determining if there would be a change.

  Parameters

  • Optionalattributes: any

  Returns any

clear

• clear(options?: Silenceable): any

  Parameters

  • Optionaloptions: Silenceable

  Returns any

clone

• clone(): Model

  Returns Model

defaults

• defaults(): ObjectHash

  Default attributes for the model. It can be an object hash or a method returning an object hash. For assigning an object hash, do it like this: this.defaults = { attribute: value, ... }; That works only if you set it in the constructor or the initialize method.

  Returns ObjectHash

destroy

• destroy(options?: ModelDestroyOptions): any

  Parameters

  • Optionaloptions: ModelDestroyOptions

  Returns any

escape

• escape(attribute: string): string

  Parameters

  • attribute: string

  Returns string

fetch

• fetch(options?: ModelFetchOptions): JQueryXHR

  Parameters

  • Optionaloptions: ModelFetchOptions

  Returns JQueryXHR

get

• get<a extends string>(attributeName: a): T[a]

  For strongly-typed access to attributes, use the get method only privately in public getter properties.

  Type Parameters

  • a extends string

  Parameters

  • attributeName: a

  Returns T[a]

  Example

  get name(): string {
     return super.get("name");
  }
  Copy

has

• has(attribute: string): boolean

  Parameters

  • attribute: string

  Returns boolean

hasChanged

• hasChanged(attribute?: string): boolean

  Parameters

  • Optionalattribute: string

  Returns boolean

initialize

• initialize(attributes?: T, options?: any): void

  Parameters

  • Optionalattributes: T
  • Optionaloptions: any

  Returns void

invert

• invert(): any

  Returns any

isEmpty

• isEmpty(): boolean

  Returns boolean

isNew

• isNew(): boolean

  Returns boolean

isValid

• isValid(options?: any): boolean

  Parameters

  • Optionaloptions: any

  Returns boolean

keys

• keys(): string[]

  Returns string[]

matches

• matches(attrs: any): boolean

  Parameters

  • attrs: any

  Returns boolean

omit

• omit(keys: string[]): any

  Parameters

  • keys: string[]

  Returns any

• omit(...keys: string[]): any

  Parameters

  • ...keys: string[]

  Returns any

• omit(fn: (value: any, key: any, object: any) => any): any

  Parameters

  • fn: (value: any, key: any, object: any) => any

  Returns any

pairs

• pairs(): any[]

  Returns any[]

pick

• pick(keys: string[]): any

  Parameters

  • keys: string[]

  Returns any

• pick(...keys: string[]): any

  Parameters

  • ...keys: string[]

  Returns any

• pick(fn: (value: any, key: any, object: any) => any): any

  Parameters

  • fn: (value: any, key: any, object: any) => any

  Returns any

preinitialize

• preinitialize(attributes?: T, options?: any): void

  For use with models as ES classes. If you define a preinitialize method, it will be invoked when the Model is first created, before any instantiation logic is run for the Model.

  Parameters

  • Optionalattributes: T
  • Optionaloptions: any

  Returns void

  See

  https://backbonejs.org/#Model-preinitialize

previous

• previous(attribute: string): any

  Parameters

  • attribute: string

  Returns any

previousAttributes

• previousAttributes(): any[]

  Returns any[]

save

• save(attributes?: any, options?: ModelSaveOptions): any

  Parameters

  • Optionalattributes: any
  • Optionaloptions: ModelSaveOptions

  Returns any

set

• set<a extends string>(attributeName: a, value?: T[a], options?: S): Model

  For strongly-typed assignment of attributes, use the set method only privately in public setter properties.

  Type Parameters

  • a extends string

  Parameters

  • attributeName: a
  • Optionalvalue: T[a]
  • Optionaloptions: S

  Returns Model

  Example

  set name(value: string) {
     super.set("name", value);
  }
  Copy

• set(attributeName: Partial<T>, options?: S): Model

  For strongly-typed assignment of attributes, use the set method only privately in public setter properties.

  Parameters

  • attributeName: Partial<T>
  • Optionaloptions: S

  Returns Model

  Example

  set name(value: string) {
     super.set("name", value);
  }
  Copy

• set<a extends string>(
      attributeName: Partial<T> | a,
      value?: S | T[a],
      options?: S,
  ): Model

  For strongly-typed assignment of attributes, use the set method only privately in public setter properties.

  Type Parameters

  • a extends string

  Parameters

  • attributeName: Partial<T> | a
  • Optionalvalue: S | T[a]
  • Optionaloptions: S

  Returns Model

  Example

  set name(value: string) {
     super.set("name", value);
  }
  Copy

unset

• unset(attribute: string, options?: Silenceable): Model

  Parameters

  • attribute: string
  • Optionaloptions: Silenceable

  Returns Model

validate

• validate(attributes: any, options?: any): any

  Parameters

  • attributes: any
  • Optionaloptions: any

  Returns any

values

• values(): any[]

  Returns any[]

Staticextend

• extend(properties: any, classProperties?: any): any

  Do not use, prefer TypeScript's extend functionality.

  Parameters

  • properties: any
  • OptionalclassProperties: any

  Returns any