Podcast

Stentor API Reference

---

Stentor API Reference / stentor-media/src / Podcast

Class: Podcast

Defined in: packages/stentor-media/src/Podcast.ts:17

Podcast

Note: Potential refactor - should this extend Playlist?

Implements

Extends

• RSSFeed\<PodcastEpisode>

Indexable

[n: number]: PodcastEpisode

Constructors

Constructor

new Podcast(podcast): Podcast

Defined in: packages/stentor-media/src/Podcast.ts:20

Parameters

podcast

PodcastProps | Podcast

Returns

Podcast

Overrides

RSSFeed.constructor

Properties

name?

optional name: string

Defined in: packages/stentor-media/src/Playlist.ts:25

Name of the playlist

Inherited from

RSSFeed.name

---

type

readonly type: "Podcast"

Defined in: packages/stentor-media/src/Podcast.ts:18

Overrides

RSSFeed.type

---

url

readonly url: string

Defined in: packages/stentor-media/src/RSSFeed.ts:25

Inherited from

RSSFeed.url

---

title?

readonly optional title: string

Defined in: packages/stentor-media/src/RSSFeed.ts:27

Inherited from

RSSFeed.title

---

description?

readonly optional description: string

Defined in: packages/stentor-media/src/RSSFeed.ts:29

Inherited from

RSSFeed.description

---

subtitle?

readonly optional subtitle: string

Defined in: packages/stentor-media/src/RSSFeed.ts:31

Inherited from

RSSFeed.subtitle

---

imageUrl?

readonly optional imageUrl: string

Defined in: packages/stentor-media/src/RSSFeed.ts:33

Inherited from

RSSFeed.imageUrl

---

explicit?

readonly optional explicit: boolean

Defined in: packages/stentor-media/src/RSSFeed.ts:35

Inherited from

RSSFeed.explicit

---

fetchTime?

readonly optional fetchTime: number

Defined in: packages/stentor-media/src/RSSFeed.ts:37

Inherited from

RSSFeed.fetchTime

---

[unscopables]

readonly [unscopables]: object

Defined in: node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Index Signature

[key: number]: boolean

find?

optional find: boolean

findIndex?

optional findIndex: boolean

fill?

optional fill: boolean

copyWithin?

optional copyWithin: boolean

[iterator]?

optional [iterator]: boolean

entries?

optional entries: boolean

keys?

optional keys: boolean

values?

optional values: boolean

[unscopables]?

readonly optional [unscopables]: boolean

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

includes?

optional includes: boolean

flatMap?

optional flatMap: boolean

flat?

optional flat: boolean

at?

optional at: boolean

findLast?

optional findLast: boolean

findLastIndex?

optional findLastIndex: boolean

toReversed?

optional toReversed: boolean

toSorted?

optional toSorted: boolean

toSpliced?

optional toSpliced: boolean

with?

optional with: boolean

length?

optional length: boolean

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

toString?

optional toString: boolean

toLocaleString?

optional toLocaleString: boolean

pop?

optional pop: boolean

push?

optional push: boolean

concat?

optional concat: boolean

join?

optional join: boolean

reverse?

optional reverse: boolean

shift?

optional shift: boolean

slice?

optional slice: boolean

sort?

optional sort: boolean

splice?

optional splice: boolean

unshift?

optional unshift: boolean

indexOf?

optional indexOf: boolean

lastIndexOf?

optional lastIndexOf: boolean

every?

optional every: boolean

some?

optional some: boolean

forEach?

optional forEach: boolean

map?

optional map: boolean

filter?

optional filter: boolean

reduce?

optional reduce: boolean

reduceRight?

optional reduceRight: boolean

Inherited from

RSSFeed.[unscopables]

---

[species]

readonly static [species]: ArrayConstructor

Defined in: node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316

Inherited from

RSSFeed.[species]

---

length

length: number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1329

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Inherited from

RSSFeed.length

Methods

concat()

concat(playlist): Playlist\<PodcastEpisode>

Defined in: packages/stentor-media/src/Playlist.ts:77

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

playlist

Playlist\<PodcastEpisode>

Returns

Playlist\<PodcastEpisode>

Inherited from

RSSFeed.concat

---

get()

get(token): PodcastEpisode

Defined in: packages/stentor-media/src/Playlist.ts:89

Get an item from the playlist either by index or string, where string is either the token or ID of the item in the playlist.

Parameters

token

string | number

Returns

PodcastEpisode

Inherited from

RSSFeed.get

---

indexOf()

indexOf(playable): number

Defined in: packages/stentor-media/src/Playlist.ts:117

Returns the index of the provided playable or token, -1 if it doesn't exist in the playlist

Parameters

playable

string | PodcastEpisode

Returns

number

Inherited from

RSSFeed.indexOf

---

next()

next(current?): PodcastEpisode

Defined in: packages/stentor-media/src/Playlist.ts:145

Get the next track in the playlist

Parameters

current?

string | PodcastEpisode

Returns

PodcastEpisode

Inherited from

RSSFeed.next

---

previous()

previous(current?): PodcastEpisode

Defined in: packages/stentor-media/src/Playlist.ts:206

Get the previous track in the playlist

Parameters

current?

string | PodcastEpisode

Returns

PodcastEpisode

Inherited from

RSSFeed.previous

---

latest()

latest(): PodcastEpisode

Defined in: packages/stentor-media/src/Playlist.ts:229

Get the latest track in the playlist

Returns

PodcastEpisode

Inherited from

RSSFeed.latest

---

toJSON()

toJSON(): RSSFeedProps\<PodcastEpisode>

Defined in: packages/stentor-media/src/RSSFeed.ts:76

Returns

RSSFeedProps\<PodcastEpisode>

Inherited from

RSSFeed.toJSON

---

find()

Call Signature

find\<S>(predicate, thisArg?): S

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:29

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type Parameters

S

S extends PodcastEpisode

Parameters

predicate

(value, index, obj) => value is S

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

S

Inherited from

RSSFeed.find

Call Signature

find(predicate, thisArg?): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:30

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

PodcastEpisode

Inherited from

RSSFeed.find

---

findIndex()

findIndex(predicate, thisArg?): number

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:41

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, obj) => unknown

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

RSSFeed.findIndex

---

fill()

fill(value, start?, end?): this

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:51

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

value

PodcastEpisode

value to fill array section with

start?

number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end?

number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

RSSFeed.fill

---

copyWithin()

copyWithin(target, start, end?): this

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:62

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

target

number

If target is negative, it is treated as length+target where length is the length of the array.

start

number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end?

number

If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

RSSFeed.copyWithin

---

from()

Call Signature

static from\<T>(arrayLike): T[]

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:72

Creates an array from an array-like object.

Type Parameters

T

T

Parameters

arrayLike

ArrayLike\<T>

An array-like object to convert to an array.

Returns

T[]

Inherited from

RSSFeed.from

Call Signature

static from\<T, U>(arrayLike, mapfn, thisArg?): U[]

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:80

Creates an array from an iterable object.

Type Parameters

T

T

U

U

Parameters

arrayLike

ArrayLike\<T>

An array-like object to convert to an array.

mapfn

(v, k) => U

A mapping function to call on every element of the array.

thisArg?

any

Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

RSSFeed.from

Call Signature

static from\<T>(iterable): T[]

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:101

Creates an array from an iterable object.

Type Parameters

T

T

Parameters

iterable

An iterable object to convert to an array.

Iterable\<T, any, any> | ArrayLike\<T>

Returns

T[]

Inherited from

RSSFeed.from

Call Signature

static from\<T, U>(iterable, mapfn, thisArg?): U[]

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:109

Creates an array from an iterable object.

Type Parameters

T

T

U

U

Parameters

iterable

An iterable object to convert to an array.

Iterable\<T, any, any> | ArrayLike\<T>

mapfn

(v, k) => U

A mapping function to call on every element of the array.

thisArg?

any

Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

RSSFeed.from

---

of()

static of\<T>(...items): T[]

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:86

Returns a new array from a set of elements.

Type Parameters

T

T

Parameters

items

...T[]

A set of elements to include in the new array object.

Returns

T[]

Inherited from

RSSFeed.of

---

[iterator]()

[iterator](): ArrayIterator\<PodcastEpisode>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

Iterator

Returns

ArrayIterator\<PodcastEpisode>

Inherited from

RSSFeed.[iterator]

---

entries()

entries(): ArrayIterator\<[number, PodcastEpisode]>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:83

Returns an iterable of key, value pairs for every entry in the array

Returns

ArrayIterator\<[number, PodcastEpisode]>

Inherited from

RSSFeed.entries

---

keys()

keys(): ArrayIterator\<number>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:88

Returns an iterable of keys in the array

Returns

ArrayIterator\<number>

Inherited from

RSSFeed.keys

---

values()

values(): ArrayIterator\<PodcastEpisode>

Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:93

Returns an iterable of values in the array

Returns

ArrayIterator\<PodcastEpisode>

Inherited from

RSSFeed.values

---

includes()

includes(searchElement, fromIndex?): boolean

Defined in: node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

searchElement

PodcastEpisode

The element to search for.

fromIndex?

number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

RSSFeed.includes

---

flatMap()

flatMap\<U, This>(callback, thisArg?): U[]

Defined in: node_modules/typescript/lib/lib.es2019.array.d.ts:64

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type Parameters

U

U

This

This = undefined

Parameters

callback

(this, value, index, array) => U | readonly U[]

A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

thisArg?

This

An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

RSSFeed.flatMap

---

flat()

flat\<A, D>(this, depth?): FlatArray\<A, D>[]

Defined in: node_modules/typescript/lib/lib.es2019.array.d.ts:75

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

A

A

D

D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray\<A, D>[]

Inherited from

RSSFeed.flat

---

at()

at(index): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es2022.array.d.ts:24

Returns the item located at the specified index.

Parameters

index

number

The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

PodcastEpisode

Inherited from

RSSFeed.at

---

findLast()

Call Signature

findLast\<S>(predicate, thisArg?): S

Defined in: node_modules/typescript/lib/lib.es2023.array.d.ts:29

Returns the value of the last element in the array where predicate is true, and undefined otherwise.

Type Parameters

S

S extends PodcastEpisode

Parameters

predicate

(value, index, array) => value is S

findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

S

Inherited from

RSSFeed.findLast

Call Signature

findLast(predicate, thisArg?): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es2023.array.d.ts:30

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

Returns

PodcastEpisode

Inherited from

RSSFeed.findLast

---

findLastIndex()

findLastIndex(predicate, thisArg?): number

Defined in: node_modules/typescript/lib/lib.es2023.array.d.ts:41

Returns the index of the last element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, array) => unknown

findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

RSSFeed.findLastIndex

---

toReversed()

toReversed(): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es2023.array.d.ts:46

Returns a copy of an array with its elements reversed.

Returns

PodcastEpisode[]

Inherited from

RSSFeed.toReversed

---

toSorted()

toSorted(compareFn?): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es2023.array.d.ts:57

Returns a copy of an array with its elements sorted.

Parameters

compareFn?

(a, b) => number

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

[11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22]

Returns

PodcastEpisode[]

Inherited from

RSSFeed.toSorted

---

toSpliced()

Call Signature

toSpliced(start, deleteCount, ...items): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es2023.array.d.ts:66

Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove.

items

...PodcastEpisode[]

Elements to insert into the copied array in place of the deleted elements.

Returns

PodcastEpisode[]

The copied array.

Inherited from

RSSFeed.toSpliced

Call Signature

toSpliced(start, deleteCount?): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es2023.array.d.ts:74

Copies an array and removes elements while returning the remaining elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove.

Returns

PodcastEpisode[]

A copy of the original array with the remaining elements.

Inherited from

RSSFeed.toSpliced

---

with()

with(index, value): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es2023.array.d.ts:85

Copies an array, then overwrites the value at the provided index with the given value. If the index is negative, then it replaces from the end of the array.

Parameters

index

number

The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.

value

PodcastEpisode

The value to write into the copied array.

Returns

PodcastEpisode[]

The copied array with the updated value.

Inherited from

RSSFeed.with

---

toString()

toString(): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1333

Returns a string representation of an array.

Returns

string

Inherited from

RSSFeed.toString

---

toLocaleString()

Call Signature

toLocaleString(): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1337

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

RSSFeed.toLocaleString

Call Signature

toLocaleString(locales, options?): string

Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:64

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

RSSFeed.toLocaleString

---

pop()

pop(): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1342

Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

PodcastEpisode

Inherited from

RSSFeed.pop

---

push()

push(...items): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1347

Appends new elements to the end of an array, and returns the new length of the array.

Parameters

items

...PodcastEpisode[]

New elements to add to the array.

Returns

number

Inherited from

RSSFeed.push

---

join()

join(separator?): string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1364

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

separator?

string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

RSSFeed.join

---

reverse()

reverse(): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1369

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

PodcastEpisode[]

Inherited from

RSSFeed.reverse

---

shift()

shift(): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1374

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Returns

PodcastEpisode

Inherited from

RSSFeed.shift

---

slice()

slice(start?, end?): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1384

Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

Parameters

start?

number

The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

end?

number

The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

Returns

PodcastEpisode[]

Inherited from

RSSFeed.slice

---

sort()

sort(compareFn?): this

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1395

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

compareFn?

(a, b) => number

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

[11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

RSSFeed.sort

---

splice()

Call Signature

splice(start, deleteCount?): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1404

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

Returns

PodcastEpisode[]

An array containing the elements that were deleted.

Inherited from

RSSFeed.splice

Call Signature

splice(start, deleteCount, ...items): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1414

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

items

...PodcastEpisode[]

Elements to insert into the array in place of the deleted elements.

Returns

PodcastEpisode[]

An array containing the elements that were deleted.

Inherited from

RSSFeed.splice

---

unshift()

unshift(...items): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1419

Inserts new elements at the start of an array, and returns the new length of the array.

Parameters

items

...PodcastEpisode[]

Elements to insert at the start of the array.

Returns

number

Inherited from

RSSFeed.unshift

---

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1431

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

searchElement

PodcastEpisode

The value to locate in the array.

fromIndex?

number

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

RSSFeed.lastIndexOf

---

every()

Call Signature

every\<S>(predicate, thisArg?): this is S[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1440

Determines whether all the members of an array satisfy the specified test.

Type Parameters

S

S extends PodcastEpisode

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this is S[]

Inherited from

RSSFeed.every

Call Signature

every(predicate, thisArg?): boolean

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1449

Determines whether all the members of an array satisfy the specified test.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

RSSFeed.every

---

some()

some(predicate, thisArg?): boolean

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1458

Determines whether the specified callback function returns true for any element of an array.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

RSSFeed.some

---

forEach()

forEach(callbackfn, thisArg?): void

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1464

Performs the specified action for each element in an array.

Parameters

callbackfn

(value, index, array) => void

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Inherited from

RSSFeed.forEach

---

map()

map\<U>(callbackfn, thisArg?): U[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1470

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type Parameters

U

U

Parameters

callbackfn

(value, index, array) => U

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

RSSFeed.map

---

filter()

Call Signature

filter\<S>(predicate, thisArg?): S[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1476

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

S

S extends PodcastEpisode

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited from

RSSFeed.filter

Call Signature

filter(predicate, thisArg?): PodcastEpisode[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1482

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

PodcastEpisode[]

Inherited from

RSSFeed.filter

---

reduce()

Call Signature

reduce(callbackfn): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1488

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => PodcastEpisode

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

PodcastEpisode

Inherited from

RSSFeed.reduce

Call Signature

reduce(callbackfn, initialValue): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1489

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => PodcastEpisode

initialValue

PodcastEpisode

Returns

PodcastEpisode

Inherited from

RSSFeed.reduce

Call Signature

reduce\<U>(callbackfn, initialValue): U

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1495

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

RSSFeed.reduce

---

reduceRight()

Call Signature

reduceRight(callbackfn): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1501

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => PodcastEpisode

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

PodcastEpisode

Inherited from

RSSFeed.reduceRight

Call Signature

reduceRight(callbackfn, initialValue): PodcastEpisode

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1502

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => PodcastEpisode

initialValue

PodcastEpisode

Returns

PodcastEpisode

Inherited from

RSSFeed.reduceRight

Call Signature

reduceRight\<U>(callbackfn, initialValue): U

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1508

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

RSSFeed.reduceRight

---

isArray()

static isArray(arg): arg is any[]

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1520

Parameters

arg

any

Returns

arg is any[]

Inherited from

RSSFeed.isArray

---

fromAsync()

Call Signature

static fromAsync\<T>(iterableOrArrayLike): Promise\<T[]>

Defined in: node_modules/typescript/lib/lib.esnext.array.d.ts:24

Creates an array from an async iterator or iterable object.

Type Parameters

T

T

Parameters

iterableOrArrayLike

An async iterator or array-like object to convert to an array.

AsyncIterable\<T, any, any> | Iterable\<T | PromiseLike\<T>, any, any> | ArrayLike\<T | PromiseLike\<T>>

Returns

Promise\<T[]>

Inherited from

RSSFeed.fromAsync

Call Signature

static fromAsync\<T, U>(iterableOrArrayLike, mapFn, thisArg?): Promise\<Awaited\<U>[]>

Defined in: node_modules/typescript/lib/lib.esnext.array.d.ts:34

Creates an array from an async iterator or iterable object.

Type Parameters

T

T

U

U

Parameters

iterableOrArrayLike

An async iterator or array-like object to convert to an array.

AsyncIterable\<T, any, any> | Iterable\<T, any, any> | ArrayLike\<T>

mapFn

(value, index) => U

thisArg?

any

Value of 'this' used when executing mapfn.

Returns

Promise\<Awaited\<U>[]>

Inherited from

RSSFeed.fromAsync