Reference
Every name each entry point exports, read from its source. Anything not listed is internal and may change in any release. The client, host and testing pages explain the API in prose, and How it fits together shows which entry point runs where.
| Entry point | Runs in | Imports React or Node |
|---|---|---|
@adecore/database | The page | React |
@adecore/database/host | The app's backend, Bun or Node | Node |
@adecore/database/protocol | Anywhere | Neither |
@adecore/database/testing | Anywhere | Neither |
Exports
@adecore/database
The views, DatabaseProvider and the client they read through.
@adecore/database/host
The host for the app's backend, and the functions that find and start the helper.
| Name | Kind | Source |
|---|---|---|
helperPath | function | host/helper-path |
HelperPathOptions | type | host/helper-path |
createDatabaseHost | function | host/host |
spawnHelper | function | host/spawn |
SpawnHelperOptions | type | host/spawn |
DatabaseHost | type | host/types |
DatabaseHostOptions | type | host/types |
HelperProcess | type | host/types |
parseRequest | function | host/validate |
ParsedRequest | type | host/validate |
@adecore/database/protocol
The messages between the page, the host and the helper: types, PROTOCOL_VERSION and valueOfCell. See Protocol.
@adecore/database/testing
An in-memory transport that answers the protocol, for demos and tests.
| Name | Kind | Source |
|---|---|---|
fakeDatabaseTransport | function | testing/fake |
FakeDatabase | type | testing/fake |
FakeDatabaseTransportOptions | type | testing/fake |
FakeTable | type | testing/fake |