Criar e usar módulos JavaScript em aplicações

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 2 min. de leitura
  • Otimize sua base de código definindo blocos de código reutilizáveis com módulos JavaScript.

    Antes de Iniciar

    Função necessária: administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Para obter informações gerais sobre a sintaxe usada para criar módulos JavaScript, consulte a página de módulos JavaScript no site do MDN Web Docs. Para usar o TypeScript em sua aplicação, consulte Usando TypeScript com o SDK ServiceNow.

    Procedimento

    1. Em Visual Studio Code, abra o diretório da aplicação com escopo.
    2. No diretório src, crie um arquivo JavaScript ou TypeScript para conter o código do módulo que você deseja reutilizar.
    3. Opcional: Importe as APIs globais do Glide para chamá-las do seu módulo.
      import { gs } from '@servicenow/glide'
    4. Exporte o código para reutilização.
      1. No módulo, identifique o código para exportar com declarações de exportação.

        Você pode usar uma exportação nomeada ou uma exportação padrão. As exportações nomeadas podem ser variáveis, constantes, funções ou classes, enquanto as exportações padrão podem ser somente funções ou classes.

        O exemplo a seguir é uma maneira de adicionar uma exportação nomeada para vários recursos (uma função e uma variável) em um módulo:
        export { myFunction, myVariable };
        
      2. No arquivo package.json da sua aplicação, declare um ponto de entrada para módulos externos e scripts de outras aplicações para acessar este módulo com o campo de exportações.
        O campo de exportações deve conter todas as chaves de subcaminho (".") ou chaves de nome de entrada principal.

        Neste exemplo, o módulo main.js é exportado do pacote da aplicação de matemática.

        {
        	"name": "math",
        	"version": "1.0.0",
        	"exports": {
        		".": "./src/main.js"
        	}
        }
    5. Para usar o código do módulo em scripts externos ou módulos em diferentes aplicações, declare o módulo como uma dependência do outro aplicativo.
      1. Abra o arquivo package.json da outra aplicação.
      2. Adicione a aplicação do módulo como uma dependência com o campo dependências.

        Neste exemplo, para usar módulos da aplicação "math", a aplicação "test" declara uma dependência dela.

        {
        	"name": "test",
        	"version": "1.0.0",
        	"dependencies": {
        		"math": "1.0.0"
        	}
        }
    6. Use o código do módulo exportado em scripts do lado do servidor ou outros módulos.
      ArquivoEtapas
      Módulo
      1. No diretório src, crie ou abra um módulo JavaScript.
      2. Importe o código do módulo com declarações de importação.
        O exemplo a seguir é uma maneira de importar um recurso exportado em um módulo:
        import { feature } from "path/to/module";
        
      3. Chame o código do módulo deste módulo para reutilizá-lo.
      Script do lado do servidor
      1. Em sua instância, abra um registro de script, como uma regra de negócios.
      2. Importe o código do módulo com declarações obrigatórias.
        O exemplo a seguir é uma maneira de importar um recurso exportado em um script:
        const { feature } = require("path/to/module");
        
      3. Chame o código do módulo deste script para reutilizá-lo.

    O que Fazer Depois

    Use bibliotecas de terceiros em um módulo JavaScript ou crie e implante suas mudanças em uma instância. Para obter mais informações, consulte Usar bibliotecas de terceiros em aplicações ou Criar e implantar uma aplicação com o SDK ServiceNow.