BasicDecayComponent.md

Class: BasicDecayComponent

• Types
  • <ComponentProps>
  • <BasicDecayComponentProps>
• Constructors
  • new BasicDecayComponent(props)
  • BasicDecayComponent.fromBinary(reader, version)
• Properties
  • hash
  • name
  • version
  • isDisabled
  • timelineEntry
• Methods
  • toBinary(version?)
  • write(writer, version?)

Types

<ComponentProps>

See <ComponentProps>

---

<BasicDecayComponentProps>

A portion of the configuration object to pass to the BasicDecayComponent constructor.

type BasicDecayComponentPropsV3 = {
  isDisabled?: boolean | undefined;
  timelineEntry?: number | undefined;
};

type BasicDecayComponentProps = BasicDecayComponentPropsV3;

Since v3

• isDisabled (optional, default true) <boolean>
• timelineEntry (optional, default 31557600000000000) <number>

Constructors

new BasicDecayComponent(props)

Creates a versioned BasicDecay component.

• props <ComponentProps & BasicDecayComponentProps> Configuration of the component to create.
• Returns: <BasicDecayComponent>

import { BasicDecayComponent } from 'att-string-transcoder';

const componentVersion = 3;
const component = new BasicDecayComponent({ version: componentVersion });

---

BasicDecayComponent.fromBinary(reader, version)

See Component.fromBinary(reader, version)

Properties

Note that the following properties are sorted in order of appearance when decoding component binary data.

hash

See Component.hash

---

name

See Component.name

---

version

See Component.version

---

isDisabled

• Since: v3
• <boolean>

import { BasicDecayComponent } from 'att-string-transcoder';

const componentVersion = 3;
const component = new BasicDecayComponent({ version: componentVersion });

const isDisabled = component.isDisabled;
// `isDisabled` is `true`

---

timelineEntry

• Since: v3
• <number>

import { BasicDecayComponent } from 'att-string-transcoder';

const componentVersion = 3;
const component = new BasicDecayComponent({ version: componentVersion });

const timelineEntry = component.timelineEntry;
// `timelineEntry` is `31557600000000000`

Methods

toBinary(version?)

See Component.toBinary(version?)

---

write(writer, version?)

See Component.write(writer, version?)