Either all code paths should have explicit returns, or none of them JS-0045
Anti-pattern
Minor
3 months ago
—
3 months old
Expected to return a value at the end of function 'getBatchExport'
10 fileContentType: string
11}
12
13export function getBatchExport(14 batchDate: number
15): GetBatchExportReturn | undefined {
16 const outstandingBatchTransactions = getBatchTransactions(batchDate, true)Expected to return a value at the end of function 'getBatchExport'
2import { getConfigProperty } from '../helpers/functions.config.js';
3import cpa005_getBatchExport from './batches/cpa005.js';
4import rbcPreauthorized_getBatchExport from './batches/rbcPreauthorized.js';
5export function getBatchExport(batchDate) { 6 const outstandingBatchTransactions = getBatchTransactions(batchDate, true);
7 console.log(outstandingBatchTransactions);
8 if (outstandingBatchTransactions.length === 0) {
Description
Any code paths that do not have explicit returns will return undefined.
It is recommended to replace any implicit dead-ends that return undefined with a return null statement.
As a convention, undefined signals that an unexpected value has been produced as the
result of a logical error in the program.
A null return, on the other hand, signals that the input to a function was incorrect,
or a value was 'not found'.
Having this distinction in code helps you figure out if something was caused because of a logical error, or malformed input to a function call.
Bad Practice
function getUser(name) {
if (userExists(name)) {
return userDb.get(name);
}
// whoops! Implicit undefined return
}
function readFile(fileName) {
if (fs.existsSync(fileName)) {
return fs.readFileSync(fileName, 'utf-8');
}
return; // Implicit undefined return.
}
Recommended
function getUser(name) {
if (userExists(name)) {
return userDb.get(name);
}
// `null` indicates there is no such user.
return null;
}
function readFile(fileName) {
if (fs.existsSync(fileName)) {
return fs.readFileSync(fileName, 'utf-8');
}
// `null` indicates there is no such file.
return null;
}