Documentation incorrect

[sjc-gh]

The documentation for some API methods is incorrect or doesn't match the code. For example:

navigateToUrl

https://single-spa.js.org/docs/api#navigatetourl

navigateToUrl(document.querySelector('a')); gives an error in TypeScript:

Argument of type 'HTMLAnchorElement | null' is not assignable to parameter of type 'string | { currentTarget: { href: string; }; preventDefault: any; }'.
Type 'null' is not assignable to type 'string | { currentTarget: { href: string; }; preventDefault: any; }'

See https://github.com/single-spa/single-spa/blob/master/typings/single-spa.d.ts#L207-L212.

document.querySelector('a').addEventListener(singleSpa.navigateToUrl); also gives an error because the first parameter to addEventListener should be an event name. Even when corrected and adding the possible return of null from querySelector, there's still an error in Typescript with the type definition of navigateToUrl not matching the event listener param:

document.querySelector('a')?.addEventListener('click', navigateToUrl);

pathToActiveWhen

https://single-spa.js.org/docs/api#pathtoactivewhen

The documentation claims the return is a function that takes a URL and returns a boolean, however according to the type definition, it takes a Location object:

https://github.com/single-spa/single-spa/blob/master/typings/single-spa.d.ts#L127

It might work in Javascript since Location and URL have the properties in common, but not Typescript. As such, all the examples shown in the documentation give errors in Typescript.