Class Attachment

An attachment to attach to a resource.

Hierarchy (view full)

Constructors

constructor

Properties

attachmentId format name

Methods

clean cleanArray iE load safeLoad validate

Constructors

constructor

  • new Attachment(newData?, options?): Attachment

  • Object initialization, setting all the default values.

    Parameters

    • OptionalnewData: any

      the data to load, optional

    • Optionaloptions: any

      custom options to apply; they will depend on the child resource

      Usually, there is no need to implement the constructor; implicitly, it will call the load of the child resource and therefore loading all the resources with default values. If needed, this is the suggested implementation:

      super();
      this.load(x);
      // ...

    Returns Attachment

Properties

attachmentId

attachmentId: string

The id of the attachment.

format

format: string

The format of the resource. (e.g. 'jpg', 'pdf').

name

name: string

The name of the resource. This can be changed when attaching to the resource.

Methods

clean

  • clean(origin, castFunction, defaultVal?): any

  • Return an attribute in a cleaned standard that force-cast the element.

    Parameters

    • origin: any

      the origin attribute, to cast

    • castFunction: ((x: any) => any)

      the cast function, e.g. Boolean, Number, String, x => new CustomClass(x), etc.

        • (x): any

        • Parameters

          • x: any

          Returns any

    • OptionaldefaultVal: any

      if set, the fallback value instead of null

    Returns any

    cleaned attribute

cleanArray

  • cleanArray(origin, castFunction, defaultVal?): any[]

  • Return an array in a cleaned standard that force-cast each element, keeping only the valid ones.

    Parameters

    • origin: any[]

      the origin array, to cast and check

    • castFunction: ((x: any) => any)

      the cast function, e.g. x => String(x) or x => new CustomClass(x)

        • (x): any

        • Parameters

          • x: any

          Returns any

    • OptionaldefaultVal: any

      if set, the fallback value instead of null

    Returns any[]

    cleaned array

iE

load

safeLoad

  • safeLoad(newData, safeData): void

  • Load the attributes from an already existing resource and then force some attributes to assume safeData values. The function is usually used in the back-end to mix together db data with new data, without the risk of changing ids and other attributes which are managed in appositely curated scenario.

    Parameters

    • newData: any

      the data to load

    • safeData: any

      the attributes to force to specific values

    Returns void

validate

  • validate(): string[]

  • Valide the object's attributes, performing all the checkings.

    Returns string[]

    errors if empty, the checkings are successfully passed.

    Typical implementation:

    const e = super.validate();
    if(this.iE(this.attr)) e.push(`attr`);
    // ...
    return e;

Settings

Member Visibility

On This Page

Constructors
Properties
Methods