54 lines
1.2 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2021-01-27 13:42:22 +01:00
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++``.
2020-06-30 12:50:59 +02:00
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
This rule raises an issue when ``++undefined++`` is returned from a void function, and when void is returned from a non-void function.
2020-06-30 12:50:59 +02:00
=== Noncompliant code example
2020-06-30 12:50:59 +02:00
2022-02-04 17:28:24 +01:00
[source,javascript]
2020-06-30 12:50:59 +02:00
----
function nonvoidFunction(): number | undefined {
return; // Noncompliant
}
function voidFunction(): void {
return undefined; // Noncompliant
}
----
=== Compliant solution
2020-06-30 12:50:59 +02:00
2022-02-04 17:28:24 +01:00
[source,javascript]
2020-06-30 12:50:59 +02:00
----
function nonvoidFunction(): number | undefined {
return undefined;
}
function voidFunction(): void {
return;
}
----
== Resources
* CWE - https://cwe.mitre.org/data/definitions/394[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[]