[Node.js] callback関数から情報を取り出したい

Question

解決したい事

そのファイルが存在するかを判定する関数を作りたい

Node.js - v12

やってみた事

├─data //dataファイル内に存在するかどうか
└─api
   └─file.js

//file.js
const isAvaiableFile = (file:string):any=>{
    new Promise((resolve, reject) => {
        fs.readdirSync(__dirname+"/../data",(err:any,files:any)=>{
            console.log(files)
            if(files.some((v:any)=>v==file)) resolve(true)
            else resolve(false)
        })
    })
}

を実行して、結果をコンソールに表示しましたが

Promise{ <pending> }

が表示されました。
どこをどのようにして修正すればよいでしょうか。

Answer 1

ほとんど miyabi-sun の回答で良いと思いますが、2つほど気になったことがありました。

1. isAvaiableFileの戻り値が指定されていない

isAvaiableFile関数ですが、戻り値が指定されていないため、このままだとエラーが発生すると思います。

const isAvaiableFile = (file:string):any=>{
    return new Promise(...)
}

と書くか、

const isAvaiableFile = (file:string):any=>( // {} ではなく、 () を使う
    new Promise(...)
)

と書く必要があります。
解説すると、アロー関数は下記の通り書くことができます。

// Pattern1 (基本的な書き方)
const func1 = (arg1, arg2) => {
    // 関数の処理
    ...
    return result // 結果を返却。書かないと戻り値はundefinedになる
}

// Pattern2 (関数の処理が1行で済むのであれば、{}とreturnを省略して書くことができる)
const func2 = (arg1, arg2) => arg1 + arg2

// Pattern3 (引数が1つの場合、引数の括弧は省略できる
const func3 = arg => {
   ...
}

// Pattern4 2と3の組み合わせ
const func4 = arg => 2 * arg

// NGパターン
const funcNG = arg => return arg // pattern2, 4の書き方でreturnをつけると構文エラーになります

先ほどの例のうち、括弧が{}の方はPattern1の書き方なのでreturnが必要です。一方で、括弧が()となっているのはPattern2の書き方と同等になります。よって()の時はreturnを省略して書きます。

アロー関数について、詳しくはこちらを参照するといいと思います。

1. readdirSync ではなく readdir ではないですか？

readdirSyncはSyncとなっている通り、同期処理をする時に使う関数なので、そもそもPromiseにする必要はないですね。非同期処理にするのであれば、readdir関数を使うべきですね。

• readdir
• readdirSync

長々と、しかも質問の回答と少しずれた回答になって恐縮ですが、これら２つを踏まえてisAvaiableFileを書き換えるとこんな感じかなと思います。

// 戻り値はPromise<T>となります。TはPromiseで渡す値の型が入ります。
// なので、今回はPromise<boolean>になるのが正しいです。
const isAvaiableFile = (file: string): Promise<boolean> => {
    // 豆知識ですが、コールバック関数に無名関数を渡す場合、TypeScriptの型推論が
    // 行われるので型の指定はしなくても大丈夫です。
    // もしエラーが出るようならおそらく型定義がインストールされていないと思います。
    return new Promise((resolve, reject) => {
        fs.readdir(__dirname + "/../data", (err, files) => {
            if (err) { // readdirに失敗した時
                reject(err)
                return
            }
            resolve(files.some((v:any) => v === file))
        })
    })
}

// もし同期処理でOKならこうかけます。ただし、同期処理はパフォーマンスに関する注意が必要です。
const isAvaiableFileSync = (file: string): boolean => {
    const files = fs.readdirSync(__dirname + "/../data")
    return files.some((v => v === file))
}

Answer 2

file.js

これはJavaScriptではなくTypeScriptですよね？
拡張子をtsにしましょう。

そのファイルが存在するかを判定する関数を作りたい

Promiseの使い方を学習しましょう。

//file.js
// Availableでは？
const isAvaiableFile = (file:string):any=>{
    new Promise((resolve, reject) => {
        fs.readdirSync(__dirname+"/../data",(err:any,files:any)=>{
            console.log(files)
            if(files.some((v:any)=>v==file)) resolve(true)
            else resolve(false)
        })
    })
}

const main1 = () => {
    const filePath = "./foo.txt"
    // Promiseはthenメソッドを叩きながらresolve(true or false)の値を取り出す事になる
    isAvaiableFile(filePath).then(isExist => {
        // promise使ったので同期処理の世界にはもう帰ってこれない
        console.log(isExist)
    })
}

// await構文を使うにはasync関数である事が必須
const main2 = async () => {
    const filePath = "./foo.txt"
    // await構文を使ってresolve(true or false)の値を取り出す
    const result = await isAvaiableFile(filePath)
    console.log(result)
}