externalSelectOption

Describes the <option /> elements to select.

Learn more

• Select
• Selected
• PageElement.selectOptions
• PageElement.selectedOptions

Hierarchy

• TinyType
  • SelectOption

Index

Constructors

• constructor

Properties

• label
• value
• selected
• disabled

Methods

• withLabel
• withValue
• toString
• equals
• toJSON

Constructors

externalconstructor

• new SelectOption(label?: string, value?: string, selected?: boolean, disabled?: boolean): SelectOption

• Overrides TinyType.constructor

  Parameters

  • externaloptionallabel: string

  • externaloptionalvalue: string

  • externaloptionalselected: boolean

  • externaloptionaldisabled: boolean

  Returns SelectOption

Properties

publicexternaloptionalreadonlylabel

label?: string

publicexternaloptionalreadonlyvalue

value?: string

publicexternaloptionalreadonlyselected

selected?: boolean

publicexternaloptionalreadonlydisabled

disabled?: boolean

Methods

staticexternalwithLabel

• withLabel(label: string): SelectOption

• Parameters

  • externallabel: string

  Returns SelectOption

staticexternalwithValue

• withValue(value: string): SelectOption

• Parameters

  • externalvalue: string

  Returns SelectOption

externaltoString

• toString(): string

• Overrides TinyType.toString

  Returns string

externalequals

• equals(another: TinyType): boolean

• Inherited from TinyType.equals

  @desc

  Compares two tiny types by value

  @example

  class Id extends TinyTypeOf<string>() {}
  
  const id = new Id(`3cc0852d-fda7-4f61-874e-0cfadbd6182a`);
  
  id.equals(id) === true

  @example

  class FirstName extends TinyTypeOf<string>() {}
  class LastName  extends TinyTypeOf<string>() {}
  class Age       extends TinyTypeOf<number>() {}
  
  class Person extends TinyType {
    constructor(public readonly firstName: FirstName,
                public readonly lastName:  LastName,
                public readonly age:       Age,
    ) {
      super();
    }
  }
  
  const p1 = new Person(new FirstName('John'), new LastName('Smith'), new Age(42)),
        p2 = new Person(new FirstName('John'), new LastName('Smith'), new Age(42));
  
  p1.equals(p2) === true

  ---

  Parameters

  • externalanother: TinyType

  Returns boolean

externaltoJSON

• toJSON(): JSONValue

• Inherited from TinyType.toJSON

  @desc

  Serialises the object to a JSON representation.

  @example

  class FirstName extends TinyTypeOf<string>() {}
  
  const name = new FirstName('Jan');
  
  name.toJSON() === 'Jan'

  @example

  class FirstName extends TinyTypeOf<string>() {}
  class LastName  extends TinyTypeOf<string>() {}
  class Age       extends TinyTypeOf<number>() {}
  
  class Person extends TinyType {
    constructor(public readonly firstName: FirstName,
                public readonly lastName:  LastName,
                public readonly age:       Age,
    ) {
      super();
    }
  }
  
  const person = new Person(new FirstName('John'), new LastName('Smith'), new Age(42)),
  
  person.toJSON() === { firstName: 'John', lastName: 'Smith', age: 42 }

  ---

  Returns JSONValue