Class PhraseySchema

constructor

• new PhraseySchema(z): PhraseySchema

• Parameters

  • z: {
        keys: ({ name: string; description?: string | undefined; parameters?: string[] | undefined; })[];
    }

    • keys: ({ name: string; description?: string | undefined; parameters?: string[] | undefined; })[]

  Returns PhraseySchema

keys

z

init

• init(): void

• Returns void

key

• key(name): {
      description?: string;
      name: string;
      parameters?: string[];
  }

• Parameters

  • name: string

  Returns {
      description?: string;
      name: string;
      parameters?: string[];
  }

  • Optional description?: string

  • name: string

  • Optional parameters?: string[]

keysCount

• keysCount(): number

• Returns number

Static create

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

• Parameters

  • path: string

  • format: string

  Returns Promise<PhraseyResult<PhraseySchema, Error>>