bugfix(doc): corrects the exposed function type definitions to correct/ canonical ones (#643)

Author: sverweij

src/extract/transpile/meta.d.ts

@@ -7,7 +7,7 @@ export interface ITranspilerWrapper {
   ) => string;
 }
 
-export function getWrapper(pExtension, pTranspileOptions): ITranspilerWrapper;
+export type getWrapper = (pExtension, pTranspileOptions) => ITranspilerWrapper;
 
 export const scannableExtensions: string[];
 
@@ -19,4 +19,4 @@ export interface IAvailableTranspiler {
   available: boolean;
 }
 
-export function getAvailableTranspilers(): IAvailableTranspiler[];
+export type getAvailableTranspilers = () => IAvailableTranspiler[];

src/validate/index.d.ts

@@ -34,27 +34,27 @@ export interface IValidationResult {
  * Validates the pModule module against the given
  * ruleset pRuleSet
  */
-export function module(
+export type module = (
   pRuleSet: IFlattenedRuleSet,
   pModule: IModule
-): IValidationResult;
+) => IValidationResult;
 
 /**
  * Validates the pFrom and pTo dependency pair against the given
  * ruleset pRuleSet
  */
-export function dependency(
+export type dependency = (
   pRuleSet: IFlattenedRuleSet,
   pFrom: IModule,
   pTo: IDependency
-): IValidationResult;
+) => IValidationResult;
 
 /**
  * Validates the pFrom and pTo dependency pair against the given
  * ruleset pRuleSet
  */
-export function folder(
+export type folder = (
   pRuleSet: IFlattenedRuleSet,
   pFromFolder: IFolder,
   pToFolder: IFolderDependency
-): IValidationResult;
+) => IValidationResult;

types/dependency-cruiser.d.ts

@@ -73,12 +73,12 @@ export interface IReporterOutput {
  *                        before calling make sure to flatten them out if you want them
  *                        used (e.g. with 'dependency-cruiser/config-utl/extract-ts-config')
  */
-export function cruise(
+export type cruise = (
   pFileAndDirectoryArray: string[],
   pCruiseOptions?: ICruiseOptions,
   pResolveOptions?: IResolveOptions,
   pTSConfig?: any
-): IReporterOutput;
+) => IReporterOutput;
 
 export interface ITranspileOptions {
   /**
@@ -113,12 +113,12 @@ export interface ITranspileOptions {
  * @param pTranspileOptions Object to hold options to pass to underlying transpilers
  *                        like TypeScript or Babel
  */
-export function futureCruise(
+export type futureCruise = (
   pFileAndDirectoryArray: string[],
   pCruiseOptions?: ICruiseOptions,
   pResolveOptions?: IResolveOptions,
   pTranspileOptions?: ITranspileOptions
-): IReporterOutput;
+) => IReporterOutput;
 
 /**
  * Given a cruise result, formats it with the given reporter (pOutputType)
@@ -127,15 +127,15 @@ export function futureCruise(
  *                    to the [dependency-cruiser results schema](https://github.com/sverweij/dependency-cruiser/blob/develop/src/schema/cruise-result.json)
  * @param pOutputType Which reporter to use to format the cruise result with
  */
-export function format(
+export type format = (
   pResult: ICruiseResult,
   pFormatOptions: IFormatOptions
-): IReporterOutput;
+) => IReporterOutput;
 
 /**
  * Returns an array of supported transpilers and for each of the transpilers
  * - the name of the transpiler
  * - the supported version range (semver version range)
  * - whether or not the transpiler is available in the current environment
  */
-export function getAvailableTranspilers(): IAvailableTranspiler[];
+export type getAvailableTranspilers = () => IAvailableTranspiler[];