Skip to content

Exposing Types for TypeScript #339

@digimbyte

Description

@digimbyte

Typings for Nano are not exposed or able to import through TypeScript

Expected Behavior

being able to define types and add Nano.ServerScope as a typings to my objects and functions
const NanoInstances = new Map<string,Nano.ServerScope>();

Current Behavior

instead, we have to create a dummy instance to localhost and extract the reference as follows

    const nanoInstance = Nano('http://localhost:5894');
    type NanoType = typeof nanoInstance;

    // Now you can use NanoType to reference the typings
    const NanoServers = new Map<string, NanoType>();

    function findDoc (instance: NanoType, doc: string){
        //...
    }

Possible Solution

just need to expose the types through an entry point or export them directly

Context

I am building a modular platform that allows multiple Nano instances to be present and are configured dynamically.
since we are using strict type safety, its better to use the correct typing's vs any or unknown

Your Environment

  • Version used: "nano": "^10.1.3",
  • Browser Name and version: node v18.17.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions