gimei/index.d.ts

Random Japanese name and address generator. Node.js port of gimei with TypeScript support.

/* Type definitions for gimei */

import { NameType } from './lib/name';
import { AddressType } from './lib/address';

export interface Gimei {
  /**
   * Generate random name (gender random)
   */
  name(): NameType;
  /** Generate male name */
  male(): NameType;
  /** Generate female name */
  female(): NameType;
  /** Generate random address */
  address(): AddressType;
}

declare const gimei: Gimei;
export = gimei;
export as namespace gimei;