Documentation: JS SDK docs improvements

[knackstedt]

Description

Following the documentation at https://surrealdb.com/docs/sdk/javascript/engines/node I noticed that it creates a seemingly impossible to satisfy condition due to the types of objects that the npm package provides. See the screenshot.

Currently running the latest versions of the surrealdb and surrealdb.node packages.

Additionally, I noticed that the export name has changed from this example and that the previous link for "Engines" leads to a 404 page.

Related to #500

Is there an existing issue for this?

• I have searched the existing issues

Code of Conduct

• I agree to follow this project's Code of Conduct

[knackstedt]

I noticed that the import for surrealdbNodeEngines is indeed provided by the surrealdb.node package, but under a specific file export like so:

import { surrealdbNodeEngines } from 'surrealdb.node/lib/embedded';

Notably it doesn't match the types of engines either, so this is probably a case of the npm package(s) needing to be updated to be in-sync with each other's APIs.

import Surreal from 'surrealdb';
import { SurrealdbNodeEngine } from 'surrealdb.node';
import { surrealdbNodeEngines } from 'surrealdb.node/lib/embedded';

const dbc = new Surreal({
    engines: surrealdbNodeEngines(),
});