Beneath JS Client Library
This folder contains the source code for the Beneath JS library. Here are some useful links:
Installation
To install the library, run:
npm install beneath
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.
Type aliases
QueryIndexResult
QueryIndexResult<TRecord>: QueryResult < TRecord >
Type parameters
QueryLogResult
QueryLogResult<TRecord>: QueryResult < TRecord >
Type parameters
Record
Record<TRecord>: TRecord & { @meta: { key: string ; timestamp: number } }
Type parameters
StreamQualifier
StreamQualifier: string | { instanceID: string } | { organization: string ; project: string ; stream: string }
WriteResult
WriteResult: { error?: Error ; writeID?: string }
Type declaration
Optional error?: Error
Optional writeID?: string
Legend
Constructor
Property
Method
Private property
Private method