Skip to main content

Word

O módulo Word é responsável por realizar ações de manipulação de arquivos criados em no Word. Seus métodos podem ser acessados conforme o exemplo abaixo:

const templateError = await Documents.PDF.toPDF["v1_0_0"]({
  outputPath: "C:/Users/Roberty/Documents/teste.docx",
    templatePath: "C:/Users/Roberty/Documents/testeTemplate.docx",
    data: {
      name: "Roberty",
      phone: "123-456-7890",
      email: "roberty@roberty.app"
    }
})

Métodos​

fillWordTemplate​

Método responsável por preencher um as variáveis de um template dinâmico do Word.

const fillError = await Documents.Word.fillWordTemplate["v2_0_0"]({
  outputPath: "C:/Users/Roberty/Documents/",
  fileName: "teste.docx",
  templatePath: "C:/Users/Roberty/Documents/testeTemplate.docx",
  data: {
    name: "Roberty",
    phone: "123-456-7890",
    email: "roberty@roberty.app"
    }
  })

Parâmetros obrigatórios​

  • outputPath: String - espera o caminho do arquivo que será preenchido.
  • fileName: String - espera o nome do arquivo que será preenchido.
  • templatePath: String - espera o caminho do template que será preenchido. O caminho deve conter o nome do arquivo e a extensão.

Parâmetros opcionais​

  • data: Objeto - espera um objeto com as variáveis que serão preenchidas no template. As chaves do objeto devem ser os nomes das variáveis do template.

Retorno​

A constante ou variável criada, como a fillError do exemplo mostrado anteriormente, receberá um valor do tipo Objeto que dará acesso as seguintes propriedades:

  • fillError.error: string - retorna uma mensagem de erro caso a preenchimento não seja realizado com sucesso.