What is the supposed workflow when using parameter types for API calls?

[jwbth]

Let's say I want to make sure the parameters I use for my calls to a certain API comply with the contract. What is my workflow for that?

E.g. when I do

const options = {
  'action': 'compare',
  'totitle': 'Text',
  'toslots': 'main',
  'totext-main': 'test',
  'topst': true,
  'prop': 'diff',
  'fromslots': 'main',
  'fromtext-main': '',
} as import('types-mediawiki/api_params').ApiComparePagesParams;
new mw.Api().post(options);

options gets highlighted by TypeScript with the error

Argument of type 'ApiComparePagesParams' is not assignable to parameter of type 'UnknownApiParams'.
  Index signature for type 'string' is missing in type 'ApiComparePagesParams'.ts(2345)

Indeed, there is no index signature in the ApiComparePagesParams interface.

UnknownApiParams is

types-mediawiki/mw/Api.d.ts

Line 19 in d050e22

type UnknownApiParams = Record<string, string | number | boolean | string[] | number[] | undefined>;

[Derugon]

Well, ApiParams (or any extending interface from api_params) can not be used to narrow UnknownApiParams, which I assume is a bug.

A fix proposed in #41 is to make ApiParams extend UnknownApiParams, and allow File objects in UnknownApiParams to prevent breakage, i.e.:

interface ApiParams extends UnknownApiParams { ... }
type UnknownApiParams = Record<string, string | number | boolean | File | string[] | number[] | undefined>;

If that's ok, I can apply that fix to the base branch.

[jwbth]

If that's ok, I can apply that fix to the base branch.

Sounds good.