File: no-throw-cr-literal.rst

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (38 lines) | stat: -rw-r--r-- 1,243 bytes parent folder | download | duplicates (20)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
no-throw-cr-literal
===================

This is similar to the ESLint built-in rule no-throw-literal. It disallows
throwing Components.results code directly.

Throwing bare literals is inferior to throwing Exception objects, which provide
stack information.  Cr.ERRORs should be be passed as the second argument to
``Components.Exception()`` to create an Exception object with stack info, and
the correct result property corresponding to the NS_ERROR that other code
expects.
Using a regular ``new Error()`` to wrap just turns it into a string and doesn't
set the result property, so the errors can't be recognised.

This option can be autofixed (``--fix``).

.. code-block:: js

    performance.timing.navigationStart + performance.now()

Often timing relative to the page load is adequate and that conversion may not
be necessary.

Examples of incorrect code for this rule:
-----------------------------------------

.. code-block:: js

   throw Cr.NS_ERROR_UNEXPECTED;
   throw Components.results.NS_ERROR_ABORT;
   throw new Error(Cr.NS_ERROR_NO_INTERFACE);

Examples of correct code for this rule:
---------------------------------------

.. code-block:: js

		throw Components.Exception("Not implemented", Cr.NS_ERROR_NOT_IMPLEMENTED);