How to use `@ts-ignore` for a block?

Question

The // @ts-ignore comment enables the TypeScript compiler to ignore the line below it.

How can one ignore a whole block of code with TypeScript?

Choker

Not even @ts-ignore works on a single line in typescript 2.4.2. I upgraded to "typescript": "2.6.1" and then it worked. – Honna

https://mcmap.net/q/74225/-how-to-disable-typescript-warnings-in-vscode – Backer

Since TypeScript 3.9, @ts-expect-error can be used. See https://mcmap.net/q/74226/-how-to-ignore-typescript-errors-with-ts-ignore – Shammer

Answer 1

You can't. This is an open issue in TypeScript.

Tiana

Is the answer still valid two years later? The typescript issue is still open but are there any other developments? – Aguilera

For those wanting to ignore a single line, add 2 lines of comments above the line you want to allow: // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore – Rondon

@Ryan, or just use /* @ts-ignore */ instead. – Hernandes

isn't that just the core of this question @Tao @Ryan? The fact that is only possible for single lines? – Palm

// @ts-nocheck - works for me - by writing in the top of the typescript file – Goraud

2023 with VSCode, so far the only option that has worked for me so far is @ts-nocheck. Added a thumb and heart to the popular/open Github Issue. – Rapparee

Answer 2

You can't.

As a workaround you can use a // @ts-nocheck comment at the top of a file to disable type-checking for that file: https://devblogs.microsoft.com/typescript/announcing-typescript-3-7-beta/

So to disable checking for a block (function, class, etc.), you can move it into its own file, then use the comment/flag above. (This isn't as flexible as block-based disabling of course, but it's the best option available at the moment.)

Rik

To clarify, you still can't. Disabling type-checking for a file is distinct from block-level disabling. – Choker

@garrettmaring Agreed; file-level disabling is just a stop-gap. (it's not always convenient or even possible to split out a given block into its own file -- but it's closer to block-level ignoring than tons of @ts-ignore comments) – Rik

use /* tslint:disable */ to do the same for tslint – Cioban

This is the answer of the question that I had weird that google got me here, Thank you :) – Axolotl

Answer 3

There is

// @ts-nocheck

It can be added at the beginning of the file and all errors in it will be ignored, isn't the block specific answer you are looking for but in some scenarios it is equivalent.

https://devblogs.microsoft.com/typescript/announcing-typescript-3-7/#ts-nocheck-in-typescript-files

While

Answer 4

You can use //@ts-nocheck at the top of the file Files

reference: Ignore all errors in a typescript file

But this is not recommended

Cyrille

Answer 5

you can use // @ts-expect-error to suppress the error on one line, and you can do it for multiple lines, a bit cumbersome but this is the CLOSEST thing you can get for now

https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-9.html#-ts-expect-error-comments

BUT WAIT

if you use // @ts-expect-error on the line that has no error, it will result in the error Unused '@ts-expect-error' directive.

This is actually GREAT, because it tells you when your type is ok and when it is not

so make sure to use it only on a line that has a type error

Soffit

Answer 6

This ignores the next line and only the next line.

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore

Esperance

that's not what OP asked. – Sheeran

Answer 7

At top of the file.

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
//@ts-nocheck

Not recommended, but if you have to disable type checking for the entire file this does the trick.

Metaphysic

Answer 8

If your goal is to ignore some method or property only in the declaration output you can use the internal annotation to do that.

Leaving this here as since this post is the top search result and I came across while searching for a way to ignore things in the declaration output.

Judaist

Answer 9

Surprised this hasn't been mentioned yet, but you can cast pretty much any type to unknown and then to its expected type. For instance, I just added this line to my code:

return <Route path={ path } Component={ (() => authPage) as unknown as ComponentType } />;
};

Cofsky

Answer 10

If you are using prettier you can add //prettier-ignore for code that is small enough that prettier just turned into more than one line

Talbot

This isn’t entirely related, but I think it still adds something to the question. Perhaps it would’ve been better as an edit or as a comment but I guess they didn’t have enough reputation to do that yet. I’ll upvote it since for some people landing here through Google this may actually help fix their problem. – Chancechancel

Answer 11

If you don't need typesafe, just bring block to a new separated file and change the extension to .js,.jsx

Phagy

Hello and welcome to SO! Please read the tour, and How do I write a good answer? I don't think that what the OP meant. – Breann