Class MyClassSealed

constructor

• new MyClass(): MyClass.MyClass

  Returns MyClass.MyClass

property

"value"
Copy

new MyClass().property; // "value"
Copy

Static ReadonlyVERSION

"1.0.0"
Copy

firstItem

• firstItem<T>(items: T[]): T

  Генерик-метод.

  Type Parameters

  • T

    Тип элементов массива.

  Parameters

  • items: T[]

    Входной массив.

  Returns T

  Первый элемент массива.

oldMethod

• oldMethod(): void

  Устаревший метод.

  Returns void

  Deprecated

  Используйте doSomething.

overloaded

• overloaded(a: string): number

  Метод с перегрузками.

  Parameters

  • a: string

    Строка.

  Returns number

  Число.

  Remarks

  Демонстрация перегрузок и @overload.

• overloaded(a: number): string

  Метод с перегрузками.

  Parameters

  • a: number

    Строка.

  Returns string

  Число.

  Remarks

  Демонстрация перегрузок и @overload.

virtualMethod

• virtualMethod(): void

  Псевдо-виртуальный метод (для демонстрации тега).

  Returns void

Staticcreate

• create(): MyClass.MyClass

  Устаревшая фабрика.

  Returns MyClass.MyClass

  Экземпляр MyClass.

  Deprecated

  Используйте MyClass.createDefault или MyClass.fromJSON.

StaticcreateDefault

• createDefault(): MyClass.MyClass

  Создаёт новый экземпляр с начальными значениями.

  Returns MyClass.MyClass

  Экземпляр MyClass.

  Example

  const instance = MyClass.createDefault();
  Copy

StaticfromJSON

• fromJSON(data: Partial<MyClass.MyContract>): MyClass.MyClass

  Создаёт экземпляр из «сырых» данных.

  Parameters

  • data: Partial<MyClass.MyContract>

    Объект частично совместимый с MyContract.

  Returns MyClass.MyClass

  Экземпляр MyClass.

  Throws

  Если данные некорректны.

  Example

  const inst = MyClass.fromJSON({ property: "x", doSomething(){} });
  Copy

StaticisMyContract

• isMyContract(value: unknown): value is MyClass.MyContract

  Проверяет, соответствует ли значение контракту MyContract.

  Parameters

  • value: unknown

    Любое значение.

  Returns value is MyClass.MyContract

  true, если объект выглядит как MyContract.

  Example

  MyClass.isMyContract({ property: "p", doSomething(){} }) === true;
  Copy

doSomething

• doSomething(param1: string, param2: number): object

  Выполняет действие.

  Parameters

  • param1: string

    Строковый параметр.
  • param2: number

    Числовой параметр.

  Returns object

  Объект с параметрами.

  Throws

  Если параметры некорректны.

  Remarks

  Основной метод для демонстрации параметров и возвращаемого значения.

  Example

  const r = new MyClass().doSomething("foo", 42);
  Copy

  Since

  0.1.0