Link Search Menu Expand Document

Creating Your Own Connection

Create a Typescript Project

You can do this however you want. The typescript-starter project is one way that is quick and gets you everything you would need to get started.

npx typescript-starter

You can then remove everything under ./src except the index.ts file and delete all the content in that file.

Add the Connection class code

Add this to the index.ts file you just cleared out:

import {Connection, ConnectionConfig} from "@nexus-switchboard/nexus-extend";

export class BasicConnection extends Connection {

    public name: string = "basic";

    public connect(): Connection {
        return undefined;

    public disconnect(): boolean {
        return false;


export default function createConnection(cfg: ConnectionConfig): Connection {
    return new BasicConnection(cfg);
Explain the Code
The connection base class constructor is given a configuration object that is passed in by the Nexus Core (and derived from the .nexus config that is specified by the app). Note that there is a factory function that is a default export of this module. It is this function that does the actual instantiation of the connection object. It is done this way because there can be multiple instances of a connection in use by one or modules in an app. Worth noting is that the factory function takes a config as its only param. That config could be used to indicate which of multiple connection objects should be created in cases where you have a more complex object model.

You’re Done!

That’s really all there is to a connection. Most of the work is done by the Nexus core but by using a Connection-derived class and implementing the connect and disconnect methods, you are providing the core with a standardized method of establish the connection and removing the connection. In more complex examples of connections you will see that the connect method contains code to instantiate an API client and uses the automatically populated config property of the connection class to fill in the authentication details for the client.

Folders vs. Published Packages

Connections can either be included in the form of a published npm package or as a folder on disk. The latter is useful in cases where you are simply making a specialized connection for your use case and have no intention to share.

Using a folder reference makes it a lot easier to make changes to connections without having to manage npm links between projects. Within the app connections config area, you will provide a path parameter that gives the relative path to the root directory where the connection project folder lives.

So, for example, if your app is here /dev/mybot/app and your connection lives here: /dev/mybot/connection then the .nexus configuration would look something like this:

    "connections": [
        "name": "connection",
        "path": ".."

If a relative path is given it will be expected to be relative to the current working directory. In most cases this is the project directory of the app.

Note that in either case, whether it’s a published package being used or a local one, the root will need to be capable of being required without the need for specifying a file. This usually means, specifying a main property in the package.json.

The example will give you a look at how to setup the relationships between connections and apps with a barebones app and custom connection.