Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PostStreamState

Index

Constructors

constructor

  • new PostStreamState(discussion: any, includedPosts?: any[]): PostStreamState

Properties

animateScroll

animateScroll: undefined | boolean

description

description: string

The description to render on the scrubber.

discussion

discussion: Discussion

The discussion to display the post stream for.

forceUpdateScrubber

forceUpdateScrubber: boolean

When the page is scrolled, goToIndex is called, or the page is loaded, various listeners result in the scrubber being updated with a new position and values. However, if goToNumber is called, the scrubber will not be updated. Accordingly, we add logic to the scrubber's onupdate to update itself, but only when needed, as indicated by this property.

index

index: number

loadNext

loadNext: throttle<() => void>

loadPageTimeouts

loadPageTimeouts: {}

Type declaration

    loadPrevious

    loadPrevious: throttle<() => void>

    loadPromise

    loadPromise: undefined | Promise<void>

    needsScroll

    needsScroll: undefined | boolean

    number

    number: number

    pagesLoading

    pagesLoading: number

    paused

    paused: boolean

    Whether or not the infinite-scrolling auto-load functionality is disabled.

    targetPost

    targetPost: undefined | { index: undefined; number: string | number } | { index: number; number: undefined }

    visible

    visible: number

    The number of posts that are currently visible in the viewport.

    visibleEnd

    visibleEnd: any

    visibleStart

    visibleStart: any

    Static loadCount

    loadCount: number

    Methods

    _loadNext

    • _loadNext(): void

    _loadPrevious

    • _loadPrevious(): void

    count

    • count(): number

    disabled

    • disabled(): boolean

    goToFirst

    goToIndex

    • goToIndex(index: number, noAnimation?: undefined | boolean): Promise<void>

    goToLast

    goToNumber

    • goToNumber(number: string | number, noAnimation?: undefined | boolean): Promise<void>
    • Load and scroll to a post with a certain number.

      Parameters

      • number: string | number

        The post number to go to. If 'reply', go to the last post and scroll the reply preview into view.

      • noAnimation: undefined | boolean = false

      Returns Promise<void>

    loadNearIndex

    • loadNearIndex(index: number): Promise<void>
    • Clear the stream and load posts near a certain index. A page of posts surrounding the given index will be loaded. Returns a promise. If the given index is already loaded, the promise will be resolved immediately.

      Parameters

      • index: number

      Returns Promise<void>

    loadNearNumber

    • loadNearNumber(number: number): Promise<void>
    • Clear the stream and load posts near a certain number. Returns a promise. If the post with the given number is already loaded, the promise will be resolved immediately.

      Parameters

      • number: number

      Returns Promise<void>

    loadPage

    • loadPage(start: number, end: number, backwards?: boolean): void

    loadRange

    • loadRange(start: number, end: number): Promise<void>

    posts

    • posts(): Post[]

    reset

    • reset(start: undefined | number, end: undefined | number): void
    • Reset the stream so that a specific range of posts is displayed. If a range is not specified, the first page of posts will be displayed.

      Parameters

      • start: undefined | number
      • end: undefined | number

      Returns void

    sanitizeIndex

    • sanitizeIndex(index: number): number

    show

    • show(posts: Post[]): void

    update

    viewingEnd

    • viewingEnd(): boolean

    Generated using TypeDoc version 0.22.10