SeriesInfoBuilder

Builder that creates an instance of the SeriesInfo object.

Extends

• Builder<ISeriesInfo>

Constructors

new SeriesInfoBuilder()

new SeriesInfoBuilder(): SeriesInfoBuilder

Returns

SeriesInfoBuilder

Inherited from

Builder.constructor

Properties

_className

protected readonly _className: string = 'SeriesInfoBuilder'

Overrides

Builder._className

Methods

build()

build(): ISeriesInfo

Builds the SeriesInfo object based on the parameters provided.

Returns

ISeriesInfo

The built SeriesInfo object containing season/episode number info for a program.

Throws

InvalidArgumentError if one or more of the required fields are missing.

Throws

IllegalStateError if the function is called after this builder instance has already built an object once.

Overrides

Builder.build

---

episode()

episode(episode): SeriesInfoBuilder

Sets the episode number.

Parameters

episode

string

The string representing the episode number. The string will be truncated if its length exceeds 256 bytes and the last 3 bytes will be replaced with "…".

Returns

SeriesInfoBuilder

The SeriesInfoBuilder object with episode number set.

Details

This field is required in order to build the SeriesInfo object.

Throws

IllegalStateError if the function is called after this builder instance has already built an object once.

Throws

InvalidArgumentError if a string that is not valid UTF-8 is passed in.

---

markBuilderAsUsed()

protected markBuilderAsUsed(): void

Returns

void

Inherited from

Builder.markBuilderAsUsed

---

season()

season(season): SeriesInfoBuilder

Sets the season number.

Parameters

season

string

The string representing the season number. The string will be truncated if its length exceeds 256 bytes and the last 3 bytes will be replaced with "…".

Returns

SeriesInfoBuilder

The SeriesInfoBuilder object with season number set.

Details

This field is required in order to build the SeriesInfo object.

Throws

IllegalStateError if the function is called after this builder instance has already built an object once.

Throws

InvalidArgumentError if a string that is not valid UTF-8 is passed in.

---

throwErrorIfBuilderAlreadyUsed()

protected throwErrorIfBuilderAlreadyUsed(): void

Returns

void

Inherited from

Builder.throwErrorIfBuilderAlreadyUsed

---

Last updated: Sep 30, 2025