scripts/apidoc/fakerUtilities.ts


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

import type { DeclarationReflection, ProjectReflection } from 'typedoc';
import { ReflectionKind } from 'typedoc';
import type { Method } from '../../docs/.vitepress/components/api-docs/method';
import { writeApiDocsModule } from './apiDocsWriter';
import { processMethods } from './moduleMethods';
import { selectApiSignature } from './typedoc';
import type { ModuleSummary } from './utils';

export function processFakerUtilities(
  project: ProjectReflection
): ModuleSummary {
  const fakerUtilities = project
    .getChildrenByKind(ReflectionKind.Function)
    .filter((method) => !method.flags.isPrivate);

  return processUtilities(fakerUtilities);
}

function processUtilities(
  fakerUtilities: DeclarationReflection[]
): ModuleSummary {
  console.log(`Processing Faker Utilities`);
  const comment = 'A list of all the utilities available in Faker.js.';

  const methods: Method[] = processMethods(
    Object.fromEntries(
      fakerUtilities.map((method) => [method.name, selectApiSignature(method)])
    )
  );

  return writeApiDocsModule('Utilities', 'utils', comment, undefined, methods);
}