search

avajs / ava

Node.js test runner that lets you develop with confidence 🚀
MIT License
20.74k stars 1.41k forks source link

API reference #2174

Closed masaeedu closed 4 years ago

masaeedu commented 5 years ago

Description

Hello. I was wondering if there's a comprehensive API reference for AVA available somewhere that documents the types of all the exports from require("ava") module? It seems this might have already been present in the README at some point and perhaps was moved, because there's various dead links in issues pointing to parts of the README that no longer exist. If not, would it be possible to add this to the README for easy reference?

Every time I have to do something non-trivial I have to spend some time flailing about trying to remember how the cb API etc. work.

novemberborn commented 5 years ago

Hi @masaeedu, do the links here help? https://github.com/avajs/ava#documentation

(I'm closing this issue for housekeeping purposes, but let's keep the conversation going.)

masaeedu commented 5 years ago

Hi @novemberborn. Not quite; I'm looking for an API reference in the vein of the following:

etc.

novemberborn commented 5 years ago

Ah I see. We could maybe generate that from our TypeScript definition file, once we have a documentation side. I haven't had time to catch up with #2051.