Class PhraseyConfig

constructor

• new PhraseyConfig(z): PhraseyConfig

• Parameters

  • z: {
        hooks?: { files: { path: string; options?: Record<string, any> | undefined; }[]; };
        input: { format: string; files: (string | string[]) & (string | string[] | undefined); fallback?: string | string[] | undefined; };
        locales?: { file: string; format: string; };
        output?: { format: string; dir: string; stringFormat: string; };
        schema: { file: string; format: string; };
    }

    • Optional hooks?: { files: { path: string; options?: Record<string, any> | undefined; }[]; }

    • input: { format: string; files: (string | string[]) & (string | string[] | undefined); fallback?: string | string[] | undefined; }

    • Optional locales?: { file: string; format: string; }

    • Optional output?: { format: string; dir: string; stringFormat: string; }

    • schema: { file: string; format: string; }

  Returns PhraseyConfig

z

Static create

• create(path, format): Promise<PhraseyResult<PhraseyConfig, Error>>

• Parameters

  • path: string

  • format: string

  Returns Promise<PhraseyResult<PhraseyConfig, Error>>