时间戳

首页 > 解决方案 > 输入选项的基本返回类型

typescript - 输入选项的基本返回类型

问题描述

AFile可以content设置为 astring或 aBuffer取决于是否设置了编码选项。

我试图重载这个函数以获得根据输入确定结果的能力。

async function readFromFileQuery (fq: Merge<FileQuery, { encoding: FileEncodings }>): Promise<Merge<File, { content: string }>>;
async function readFromFileQuery (fq: Merge<FileQuery, { encoding: null }>): Promise<Merge<File, { content: Buffer }>>;
async function readFromFileQuery (fq: FileQuery): Promise<File> {
    const { path, encoding, flag } = FileQueryHandler.make(fq);
    const content = await promisify(fs.readFile)(path, { encoding, flag })
    return { path, encoding, flag, content };
}

readFromFileQuery({ path: './File.ts', encoding: FileEncodings.UTF8 }).then(r => {
    console.log(r);
});

如何在 TypeScript 中实现这一点？

标签： typescript

解决方案

不确定您的所有类型是什么，但如果参数类型的形状在重载之间不兼容，您可以轻松地重载参数。

这按预期工作 

import { promisify } from "util";
import * as fs from 'fs'


async function readFromFileQuery(fq: Merge<FileQuery, { encoding: FileEncodings }>): Promise<Merge<File, { content: string }>>;
async function readFromFileQuery (fq: Merge<FileQuery, { encoding?: null | undefined}>): Promise<Merge<File, { content: Buffer }>>;
async function readFromFileQuery (fq: FileQuery): Promise<File> {
    const { path, encoding, flag } = FileQueryHandler.make(fq);
    const content = await promisify(fs.readFile)(path, { encoding, flag })
    return { path, encoding: encoding as FileEncodings, flag, content };
}

readFromFileQuery({ path: './File.ts', encoding: FileEncodings.UTF8 }).then(r => {
    console.log(r.content); // string
});

readFromFileQuery({ path: './File.ts' }).then(r => {
  console.log(r.content); // Buffer
});

readFromFileQuery({ path: './File.ts', encoding: null }).then(r => {
  console.log(r.content); // Buffer
});

// Some assumptions
type Merge<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U 
enum FileEncodings {
  UTF8  ="UTF8"
}
interface FileQuery {
  path: string,  flag?: string, encoding?: FileEncodings | null
}
export interface File {
  path: string,  flag?: string, encoding: string, content: Buffer | string
}

declare var FileQueryHandler: {
  make(fq: FileQuery) : FileQuery
}

推荐阅读