Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

53 lines
1.2 KiB
Plaintext

== Why is this an issue?
Every call to a function with a non-void return type is expected to return some value. If there is no value that's valid, you should ``++return undefined;++`` rather than using a void return (``++return;++``). Conversely, every call to a function with a void return type is expected to not return any value, even ``++undefined++``.
This rule raises an issue when ``++undefined++`` is returned from a void function, and when void is returned from a non-void function.
=== Noncompliant code example
[source,javascript]
----
function nonvoidFunction(): number | undefined {
return; // Noncompliant
}
function voidFunction(): void {
return undefined; // Noncompliant
}
----
=== Compliant solution
[source,javascript]
----
function nonvoidFunction(): number | undefined {
return undefined;
}
function voidFunction(): void {
return;
}
----
== Resources
* https://cwe.mitre.org/data/definitions/394[MITRE, CWE-394] - Unexpected Status Code or Return Value
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]