patronum
patronum copied to clipboard
Expose timers API
Description
Checklist for a new method
- [ ] Create a directory for the new method in the
src
directory inparam-case
- [ ] Place the source code to
src/method-name/index.ts
in ESModules export incamelCase
named export - [ ] Add tests to
src/method-name/method-name.test.ts
- [x] Add fork tests to
src/method-name/method-name.fork.test.ts
- [ ] Add type tests to
test-typings/method-name.ts
- Use
// @ts-expect-error
to mark expected type error -
import { expectType } from 'tsd'
to check expected return type
- Use
- [x] Add documentation in
src/method-name/readme.md
- Add header
Patronum/MethodName
- Add section with overloads, if have
- Add
Motivation
,Formulae
,Arguments
andReturn
sections for each overload - Add useful examples in
Example
section for each overload
- Add header
- [ ] Add section to
README.md
in the repository root- Add method to the table of contents into correct category
- [MethodName](#methodname) - description.
- Add section
## MethodName
- Add
[Method documentation & API](/src/method-name)
into section - Add simple example
- Add method to the table of contents into correct category