Usando typescript em módulos JavaScript com ServiceNow SDK

Use typescript ao criar módulos JavaScript com ServiceNow SDK.

O typescript usa digitação estática e anotações de tipo para oferecer suporte aos desenvolvedores para detectar erros mais cedo ao escrever código Visual Studio Code.

Para obter informações gerais sobre como usar typescript, consulte Documentação do typescript no site typescriptlang.org.

Use typescript em módulos JavaScript

Use typescript em módulos JavaScript adicionando suporte para typescript em sua aplicação.

Antes de Iniciar

Instale o typescript versão 4.8.4 ou posterior. Para obter instruções de instalação, consulte Baixar typescrippt no site typescriptlang.org.

Função necessária: administrador

Por Que e Quando Desempenhar Esta Tarefa

Siga este procedimento para atualizar aplicações existentes que não foram criadas usando um modelo typescript para usar typescript em módulos . Começando com ServiceNow SDKVersão 3,0, suporte a aplicações usando typescript em módulos JavaScript por padrão usando opções de compilador padrão. Para usar um tsconfig.json Arquivo com opções personalizadas para transplicar o typescript para JavaScript durante o processo de compilação, configure o. TsconfigPath parâmetro no now.config.json arquivo. Se você quiser usar uma etapa de transpilação personalizada antes de criar a aplicação, configure o. ModulePaths parâmetro no now.config.json arquivo.

Procedimento

1. Em Visual Studio Code, abra o diretório da aplicação com escopo.
2. Abra as aplicações pacote.json arquivo e. em Dependências Objeto, adicione o pacote e a versão do typescript .

   "devDependencies": {
       "typescript": "<version>",
       "@servicenow/sdk": "2.0.0",
       "@servicenow/glide": "26.0.1",
       "eslint": "8.50.0",
       "@servicenow/eslint-plugin-sdk-app-plugin": "2.0.0"
     }

3. Em sua aplicação src/servidor diretório, adicione um tsconfig.json arquivo que define as opções para compilar a aplicação.

   {
       "compilerOptions": {
           "rootDir": "./",
           "outDir": "../../dist/server",
           "module": "es2022",
           "target": "es2022",
           "moduleResolution": "bundler",
           "allowJs": true,
           "declaration": false,
           "sourceMap": false,
           "skipLibCheck": true,
           "allowImportingTsExtensions": true,
           "noEmit": true
       },
       "include": [
           "./**/*.ts",
           "../../@types/**/*.modules.d.ts"
       ],
       "exclude": [
           "**/*.now.ts"
       ]
   }

4. Na aplicação now.config.json arquivo, defina o. TsconfigPath parâmetro para o local do tsconfig.json Para módulos JavaScript. .

   {
     "scope": "x_snc_example_app",
     "scopeId": "2f8400eb07426110f736e28f69d3017a",   
     "name": "ExampleApp",
     "tsconfigPath": "./src/server/tsconfig.json"
     
   }

5. Em src/servidor diretório, adicione pelo menos um .ts arquivo para conter o código do módulo.
   Para obter informações sobre como criar módulos, consulte Crie e use módulos JavaScript em aplicações com ServiceNow SDK.
6. Compile arquivos typescript em módulos JavaScript e crie sua aplicação.
   1. No diretório da aplicação, abra uma ferramenta de linha de comando no sistema.
   2. Insira o seguinte comando:

      now-sdk build

Adicione definições de tipo para APIs

Obtenha suporte de autodigitação para APIs e objetos programáveis fora das APIs Glide.

Antes de Iniciar

Função necessária: administrador

Por Que e Quando Desempenhar Esta Tarefa

Nota:

Você pode baixar definições de tipo para a maioria das APIs, inclusões de script e outros objetos programáveis usando o. dependências do now-sdk comando. Para obter mais informações, consulte Download e. dependências de script.

Siga este procedimento para adicionar manualmente definições de tipos ao dependências do now-sdk não faz download. Você pode declarar módulos diretamente no ServiceNow SDKAcesso às APIs para stub para suporte de autodigitação. Esses módulos não são empacotados no pacote da aplicação, mas podem ser rastreados em um repositório de controle de código-fonte da aplicação e compartilhados entre desenvolvedores.

Procedimento

1. Em Visual Studio Code, abra o diretório da aplicação com escopo.
2. Em sua aplicação, adicione um TypeScript ( .ts ) para definições de tipo.
3. Em seu arquivo typescript, declare módulos para APIs e objetos programáveis.
   Este exemplo declara um módulo para uma API usando o namespace da API ( sn_app_api ):

   declare module '@servicenow/glide/sn_app_api' {
   	class AppStoreAPI {
   		static canUpgradeAnyStoreApp(): boolean
   	}
   } 

   Este exemplo declara um módulo para acessar objetos definidos em inclusões de script usando o escopo da inclusão de script ( x_1234_escopo ):

   declare module '@servicenow/glide/x_1234_scope' {
   	class MyLogItemClass {
   		myLogFunction()
   	}
   }

4. Em módulos JavaScript em sua aplicação, importe os módulos declarados.
   Este exemplo importa o módulo declarado para a AppStoreAPI.

   import { gs } from '@servicenow/glide'
   import { AppStoreAPI } from '@servicenow/glide/sn_app_api'
   
   export const canUpgradeStoreApp = function () {
   	var canUpgrade = AppStoreAPI.canUpgradeAnyStoreApp()
   	if (canUpgrade) {
   		gs.addInfoMessage(`You can upgrade store apps!`)
   	} else {
   		gs.addInfoMessage(`You cannot upgrade store apps!`)
   	}
   }

   Este exemplo importa o módulo declarado para o objeto MyLogItemClass.

   import { MyLogItemClass } from '@servicenow/glide/x_1234_scope'
   
   export const myLogFunction = function (status) {
   	const myLogItem = new MyLogItemClass()
   	myLogItem.myLogFunction(status)
   }

   Nota:

   Os módulos podem acessar somente objetos programáveis globais ou objetos programáveis no mesmo escopo da aplicação.