Possible to change the TypeScript interface for built in JavaScript object (JSON)?

Question

JSON.strigify() breaks with cyclic objects (as per https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Cyclic_object_value )

The same article recommends 'cycle.js' - which adds 2 methods to the global JSON object - .decycle() & .retrocycle() to stringify cyclic objects.

This works great, but typescript complains unless I add

//@ts-ignore

or other ts hacks - JSON [ 'retrocycle' ] (), etc - which I can do but it's not pretty.

Is there anyway to create something like a "JSON.d.ts" file to override the default TS interface for the global JSON object?

ChrisNY · Accepted Answer · 2022-03-18 16:22:49Z

1

Not sure why this was closed & then re-opened - but by putting together several threads, I came up with this - in case anyone else is interested:

Create a .d.ts typefile, say in src/custom_types:

src/custom_types/JSON.d.ts

In JSON.d.ts:

export declare global {
    interface JSON {
            decycle(object: any, replacer?: any): string;
            retrocycle(something: any): any;
    }
}

In tsconfig.json:

{
  "compilerOptions": {
    ...
    "baseUrl": ".",
    ...
    "paths" : {
      ...
    "*" : ["src/custom_types/*"],
    }
  },
  "typeRoots": [
    ....
    "src/custom_types/",
    ],
}

answered Mar 18, 2022 at 16:22

ChrisNY

4,2575 gold badges32 silver badges36 bronze badges

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

Collectives™ on Stack Overflow

Possible to change the TypeScript interface for built in JavaScript object (JSON)?

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related