Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubscriptionsResponse

Package version

Represents result of list operation on subscriptions.

Hierarchy

Indexable

Represents result of list operation on subscriptions.

Index

Properties

Array

Array: ArrayConstructor

_response

_response: HttpOperationResponse

The underlying HTTP response.

length

length: number

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

Methods

[Symbol.iterator]

[Symbol.unscopables]

  • [Symbol.unscopables](): { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean }

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

concat

  • Combines two or more arrays.

    Parameters

    Returns SubscriptionDescription[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SubscriptionDescription[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • 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.

    • Optional end: undefined | number

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

    Returns this

entries

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

    Returns IterableIterator<[number, SubscriptionDescription]>

every

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

    Parameters

    • callbackfn: (value: SubscriptionDescription, index: number, array: SubscriptionDescription[]) => unknown

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

    • Optional 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 boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SubscriptionDescription

      value to fill array section with

    • Optional start: undefined | 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.

    • Optional end: undefined | number

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

    Returns this

filter

find

findIndex

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

    Parameters

    Returns number

forEach

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SubscriptionDescription

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

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

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SubscriptionDescription

      The value to locate in the array.

    • Optional fromIndex: undefined | number

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

    Returns number

map

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

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns SubscriptionDescription | undefined

push

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

    Parameters

    Returns number

reduce

reduceRight

reverse

shift

  • Removes the first element from an array and returns it.

    Returns SubscriptionDescription | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns SubscriptionDescription[]

some

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

    Parameters

    • callbackfn: (value: SubscriptionDescription, index: number, array: SubscriptionDescription[]) => unknown

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

    • Optional 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 boolean

sort

  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | ((a: SubscriptionDescription, b: SubscriptionDescription) => number)

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

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

    Returns this

splice

  • 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.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SubscriptionDescription[]

  • 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.

    • Rest ...items: SubscriptionDescription[]

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

    Returns SubscriptionDescription[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<SubscriptionDescription>

Generated using TypeDoc