The connection options, see the class docs for an example
Optional type for the records in the stream. No error is thrown if it doesn't correctly correspond to the stream's schema; it is for type hinting purposes only.
Identifies the stream to find
Pings the server and reports a) whether the user is authenticated, b) the library version is up-to-date
Parameters of the warehouse query to execute
Generated using TypeDoc
Clientis the root class for interfacing with Beneath from the browser. It is a wrapper for the Beneath REST APIs. You can use it to read from and write data to streams, and to run warehouse queries.
To instantiate a new client and find a stream:
If your code runs in the browser (i.e. it's part of your frontend), you must use a read-only secret. You can obtain a new secret from your settings page on https://beneath.dev.
Note that you can use this class from outside the browser, but it uses the less performant REST APIs, not the gRPC APIs (like the Python client does).