TypeScript 関数で戻り値の型は、`satisfies` で縛るべき？ 戻り値型を指定すべき？

Question

TypeScript での satisfies の機能をうまく把握できず、使うべきタイミングがよくわかりません…

たとえば以下のように [規定値を返す場合] と [オプショナルな場合] があるとしたら、方針としては A / B のどちらが推奨されますか？

A: 即時 return と satisfies で使い分ける方針

[規定値を返す場合]: 即時 return を使う

export function createAaaUseCases(
    config: AaaUseCasesConfig
): AaaUseCases { // ️☑️戻り値型で縛る
    return {
        async create() { ... },
        async cancel() { ... },
    }; // ⚠️satisfiesで縛らない（returnなので縛れない）
}

[オプショナルな場合]: satisfies を使う

export function createBbbUseCases(
    config: BbbUseCasesConfig
) { // ⚠️戻り値型で縛らない
    const bbb = {
        async create() { ... },
        async cancel() { ... },
    } satisfies BbbUseCases; // ✅satisfiesで縛る

    // オプショナルな条件を追加
    if (config.data) {
        bbb.update = () => { ... };
    }

    return bbb;
}

B: 念のために常に satisfies にする方針

[規定値を返す場合]: satisfies を使う

export function createAaaUseCases(
    config: AaaUseCasesConfig
) { // ⚠️戻り値型で縛らない
    const aaa = {
        async create() { ... },
        async cancel() { ... },
    } satisfies AaaUseCases; // ✅satisfiesで縛る

    return bbb;
}

[オプショナルな場合]: satisfies を使う

export function createBbbUseCases(
    config: BbbUseCasesConfig
) { // ⚠️戻り値型で縛らない
    const bbb = {
        async create() { ... },
        async cancel() { ... },
    } satisfies BbbUseCases; // ✅satisfiesで縛る

    // オプショナルな条件を追加
    if (config.data) {
        bbb.update = () => { ... };
    }

    return bbb;
}

Answer 1

返り値型をすんなり書いて、それで型が決まる場合にsatisfiesを入れるのは過剰かなという気もします。

ただ、タプルを引き回すような複雑な式を作るような場合、式の途中でタプルだと宣言させるのは有用だと考えます。

あと、定数の宣言時にas const satisfiesとすることで、リテラル型と特定の型を満たすことの両取りができるのも便利です。

Comments

[kuzuha]

どうもありがとうございます。タプルという語も as const satisfies という方法も知らなったので、調べることで周辺の知識が広がるきっかけにもなりました。