Closed egoson closed 10 months ago
src
param-case
src/method-name/index.ts
camelCase
src/method-name/method-name.test.ts
src/method-name/method-name.fork.test.ts
test-typings/method-name.ts
// @ts-expect-error
import { expectType } from 'tsd'
src/method-name/readme.md
Patronum/MethodName
Motivation
Formulae
Arguments
Return
Example
README.md
- [MethodName](#methodname) - description.
## MethodName
[Method documentation & API](/src/method-name)
Description
Checklist for a new method
src
directory inparam-case
src/method-name/index.ts
in ESModules export incamelCase
named exportsrc/method-name/method-name.test.ts
src/method-name/method-name.fork.test.ts
test-typings/method-name.ts
// @ts-expect-error
to mark expected type errorimport { expectType } from 'tsd'
to check expected return typesrc/method-name/readme.md
Patronum/MethodName
Motivation
,Formulae
,Arguments
andReturn
sections for each overloadExample
section for each overloadREADME.md
in the repository root- [MethodName](#methodname) - description.
## MethodName
[Method documentation & API](/src/method-name)
into section