Add definition to existing module in Typescript

Question

I am struggling with Typescript and modifying the definition of existing module.

We are used to put anything we want to output to "res.out" and at the end there is something like this "res.json(res.out)". This allows us to have general control over the app at the moment of sending the response.

So I have function like this

export async function register(req: Request, res: Response, next: Next) {
    try {
        const user = await userService.registerOrdinaryUser(req.body)
        res.status(201);
        res.out = user;
        return helper.resSend(req, res, next);
    } catch (ex) {
        return helper.resError(ex, req, res, next);
    }
};

We are using restify. And I get compilation error, because "out" is not part of restify.Response.

Now we have workaround that we have our "own" objects, that extends the Restify ones.

import {
    Server as iServer,
    Request as iRequest,
    Response as iResponse,
} from 'restify'

export interface Server extends iServer {
}

export interface Request extends iRequest {
}

export interface Response extends iResponse {
    out?: any;
}

export {Next} from 'restify';

We just did this to make project compilable, but looking for better solution. I have tried things like this:

/// <reference types="restify" />

namespace Response {
    export interface customResponse;
}

interface customResponse {
    out?: any;
}

But it does not work, right now it says "Duplicate identifier 'Response'".

So anyone how to add definition to restify.Response object with some simple code?

Saravana · Accepted Answer · 2017-09-18 11:13:03Z

5

You can use interface merging.

import {  Response } from "restify";
declare module "restify" {
    interface Response {
        out?: any
    }
}

edited Sep 18, 2017 at 11:13

answered Sep 18, 2017 at 9:49

Saravana

41k20 gold badges110 silver badges112 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

libik Over a year ago

I have tried and it completely "delete" the original 'restify' and put this in its position, therefore now the only things that typescript knows is Response.out

Saravana Over a year ago

@libik You need to import the original interface you want to extend. See the updated answer.

zamuka Over a year ago

Importing the original interface makes this augmentation file inactive for some reasons

Collectives™ on Stack Overflow

Add definition to existing module in Typescript

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related