avajs/ava

Provide type definitions for the JS configuration files.

Open

#3042 aperta il 2 giu 2022

Vedi su GitHub
 (3 commenti) (4 reazioni) (0 assegnatari)JavaScript (1408 fork)batch import
enhancementhelp wantedscope:typescript

Metriche repository

Star
 (20.600 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Continuing https://github.com/avajs/typescript/issues/15#issuecomment-1140477835 cc @novemberborn


Summary

When a user configures AVA with JavaScript, it would be useful to have type definition. Users might consume these through JSDoc comments, or through a typed wrapper function.

Details

A wrapper function would be defined like this:

/**
 *
 * Configure AVA, with intellisense
 *
 * @param {Config} config - A configuration object
 * @returns {Config}
 */
export const defineConfig = (config) => config;

The function would be used like this:

import { defineConfig } from 'ava/config';

export default defineConfig({
  // ...
})

Guida contributor