TypeDoc Array Extension Bug Report
    Preparing search index...

    Class Posts

    An array of posts fetched from the main site.

    Hierarchy

    Indexable

    Index

    Constructors

    • Parameters

      • query: string

      Returns Posts

    Properties

    length: number

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

    query: string

    The query used to fetch these posts.

    total: number

    The total amount of results under the used query.

    Methods

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

      Parameters

      • ...items: ConcatArray<Post>[]

        Additional arrays and/or items to add to the end of the array.

      Returns Post[]

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

      Parameters

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

        Additional arrays and/or items to add to the end of the array.

      Returns Post[]

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

      Type Parameters

      Parameters

      • predicate: (value: Post, index: number, array: Post[]) => 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.

      • OptionalthisArg: 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[]

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

      Parameters

      • predicate: (value: Post, index: number, array: Post[]) => 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.

      • OptionalthisArg: 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

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

      Type Parameters

      Parameters

      • predicate: (value: Post, index: number, array: Post[]) => 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.

      • OptionalthisArg: 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[]

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

      Parameters

      • predicate: (value: Post, index: number, array: Post[]) => unknown

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

      • OptionalthisArg: 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 Post[]

    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: (value: Post, index: number, array: Post[]) => void

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

      • OptionalthisArg: 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

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

      Parameters

      • searchElement: Post

        The value to locate in the array.

      • OptionalfromIndex: number

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

      Returns number

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

      Parameters

      • Optionalseparator: 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

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

      Parameters

      • searchElement: Post

        The value to locate in the array.

      • OptionalfromIndex: 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

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

      Type Parameters

      • U

      Parameters

      • callbackfn: (value: Post, index: number, array: Post[]) => U

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

      • OptionalthisArg: 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[]

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

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

      Parameters

      • ...items: Post[]

        New elements to add to the array.

      Returns number

    • 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: Post,
            currentValue: Post,
            currentIndex: number,
            array: Post[],
        ) => Post

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

      Returns Post

    • Parameters

      • callbackfn: (
            previousValue: Post,
            currentValue: Post,
            currentIndex: number,
            array: Post[],
        ) => Post
      • initialValue: Post

      Returns Post

    • 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

      Parameters

      • callbackfn: (previousValue: U, currentValue: Post, currentIndex: number, array: Post[]) => 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

    • 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: Post,
            currentValue: Post,
            currentIndex: number,
            array: Post[],
        ) => Post

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

      Returns Post

    • Parameters

      • callbackfn: (
            previousValue: Post,
            currentValue: Post,
            currentIndex: number,
            array: Post[],
        ) => Post
      • initialValue: Post

      Returns Post

    • 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

      Parameters

      • callbackfn: (previousValue: U, currentValue: Post, currentIndex: number, array: Post[]) => 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

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

      Returns Post[]

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

    • 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

      • Optionalstart: number

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

      • Optionalend: 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 Post[]

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

      Parameters

      • predicate: (value: Post, index: number, array: Post[]) => 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.

      • OptionalthisArg: 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

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

      Parameters

      • OptionalcompareFn: (a: Post, b: Post) => 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

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

      • OptionaldeleteCount: 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 Post[]

      An array containing the elements that were deleted.

    • 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: Post[]

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

      Returns Post[]

      An array containing the elements that were deleted.

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

      Returns string

    • Returns a string representation of an array.

      Returns string

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

      Parameters

      • ...items: Post[]

        Elements to insert at the start of the array.

      Returns number

    • Parameters

      • arg: any

      Returns arg is any[]