Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] The parameter explanation for the afterBuild option in README.md is incorrect. #333

Open
2 tasks done
s3xysteak opened this issue May 24, 2024 · 0 comments
Open
2 tasks done

Comments

@s3xysteak
Copy link

Description

相比于README.zh-CN.md,README.md中afterBuild选项的参数说明错误

/**
 * Hook called after all declaration files are written
 *
 * It will be received a map (path -> content) that records those emitted files
 *
 * @default () => {}
 */
afterBuild?: () => MaybePromise<void>
/**
 * 在所有类型文件被写入后的钩子
 *
 * 它会接收一个记录了那些最终被写入的文件的映射(path -> content)
 *
 * @default () => {}
 */
afterBuild?: (emittedFiles: Map<string, string>) => MaybePromise<void>

Suggested solution

修复README的错误

Alternative

No response

Additional context

No response

Validations

  • Read the FAQ.
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant