beneath-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Beneath React Client Library

NPM version Docs badge License Netlify Status

This folder contains the source code for the Beneath React library. Here are some useful links:

Installation

To install the library, run:

npm install beneath-react

Providing feedback

Beneath is just entering public beta, so there's bound to be some rough edges. Bugs, feature requests, suggestions – we'd love to hear about them. Click here to file an issue.

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

FetchMoreFunction

FetchMoreFunction: (opts?: FetchMoreOptions) => Promise<void>

Type declaration

FetchMoreOptions

FetchMoreOptions: { pageSize?: number }

Type declaration

  • Optional pageSize?: number

QueryWarehouseFunction

QueryWarehouseFunction: (query: string) => void

Type declaration

    • (query: string): void

    • Parameters

      • query: string

      Returns void

Record

Record<TRecord>: TRecord & { @meta: { key: string; timestamp: number } }

Type parameters

  • TRecord = any

StreamQualifier

StreamQualifier: string | { instanceID: string } | { organization: string; project: string; stream: string }

UseWarehouseOptions

UseWarehouseOptions: { pageSize?: number; secret?: string }

Type declaration

  • Optional pageSize?: number
  • Optional secret?: string

UseWarehouseResult

UseWarehouseResult<TRecord>: { analyzeQuery: QueryWarehouseFunction; client: Client; error?: Error; fetchMore?: FetchMoreFunction; job?: Job<TRecord>; loading: boolean; records?: Record<TRecord>[]; runQuery: QueryWarehouseFunction }

Type parameters

  • TRecord

Type declaration

Functions

useRecords

  • React hook that you can use to query streams, including paging through data and getting real-time updates over websockets.

    Type parameters

    • TRecord = any

    Parameters

    Returns UseRecordsResult<TRecord>

useWarehouse

Legend

  • Property

Generated using TypeDoc