@yamlresume/node
    Preparing search index...

    Function readResume

    • Read the resume from the source file and validate it on request.

      Steps:

      1. read the resume from the source file
      2. validate the resume with yaml.parse
      3. if validate is true, validate the resume with ResumeSchema

      Parameters

      • resumePath: string

        The source resume file path (YAML, YML, or JSON).

      • options: ReadResumeOptions = {}

        Options for reading and validating the resume.

      Returns ReadResumeResult

      The resume object.

      If the source file cannot be read or is invalid.

    Settings
    Member Visibility