Class Membership

This class serve two purposes:

  1. To represent the resource IDEA Membership, which is stored in the table below.
  2. To give a generic representation to the concept of Membership in IDEA's project.

Table: idea_teams_users.

Indexes:

  • userId-index.

Hierarchy

Constructors

constructor

Properties

initials? name pendingInvitation? teamId userId

Methods

clean cleanArray iE load safeLoad validate

Constructors

constructor

  • Object initialization, setting all the default values.

    Parameters

    • Optional newData: any

      the data to load, optional

    • Optional options: 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 Membership

Properties

Optional initials

initials?: string

If set, a short representation of the name, through initials.

name

name: string

The name of the user in the team. In generic scenarios, it's usually the user's email address.

Optional pendingInvitation

pendingInvitation?: boolean

Whether the user has still to accept the invitation to join the team.

teamId

teamId: string

The id of the team.

userId

userId: string

The id of the user (Cognito sub).

Methods

clean

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

    Parameters

    • origin: any

      the origin attribute, to cast

    • castFunction: ((x) => any)

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

        • (x): any

        • Parameters

          • x: any

          Returns any

    • Optional defaultVal: any

      if set, the fallback value instead of null

    Returns any

    cleaned attribute

cleanArray

  • 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)

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

        • (x): any

        • Parameters

          • x: any

          Returns any

    • Optional defaultVal: any

      if set, the fallback value instead of null

    Returns any[]

    cleaned array

iE

load

safeLoad

  • 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

  • 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

Theme

On This Page

Generated using TypeDoc