https://github.com/chovanecm/tsnow
TypeScript-based tools for ServiceNow
https://github.com/chovanecm/tsnow
Last synced: about 1 month ago
JSON representation
TypeScript-based tools for ServiceNow
- Host: GitHub
- URL: https://github.com/chovanecm/tsnow
- Owner: chovanecm
- License: gpl-3.0
- Created: 2019-12-07T12:44:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T08:14:05.000Z (2 months ago)
- Last Synced: 2025-03-29T05:14:14.411Z (about 2 months ago)
- Language: JavaScript
- Size: 1.09 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tsnow
TypeScript-based tools for ServiceNow. Alpha version.
## Purpose
tsnow uses TypeScript to inspect and enable auto-completion for ServiceNow scripts.
It does so by providing TypeScript definition files for the ServiceNow server-side API
and combining them with definition files generated from database schema of your ServiceNow instance.
You don't longer need to remember field names of your tables or search in the official incomplete API documentation. *work in progress :-)*
## Installation
### Requirements
- nodejs v12 or above
- your favorite code editor with a TypeScript plugin enabled
- a ServiceNow instance
### Installation Steps
- clone this repository
- run:
```console
npm install && npm link
```
- switch to the root directory of your ServiceNow project (i.e. where you sync your scripts to)
- See the help and download the definitions you need.
- The first time you ask tsnow to generate definitions, it will download the whole database schema (without actual data) from your instance.
That can take some time. It will cache it for future calls.
```console
you@yourcomputer:~$ tsnow --help
Usage: tsnow [options]
Build TypeScript definitions for the given instance in the current directory.
tables: specify one or more tables to add to the current project. Use exact_table_name or *contains_name or starts_with_name*
All parent and reference tables are included to encompass the transitive closure of references.
Options:
-V, --version output the version number
-r|--reference-keys The number of dot-walks to support in addQuery. The more, the slower type checking.
(default: 1)
-h, --help output usage information
```
### Using it
The tool should create a new file `tsconfig.json` and a directory called `@types`.
Open your code editor with an enabled TypeScript plugin. The editor will run `tsc` (TypeScript compiler) in the background and starts
checking and auto-complete your code as you are typing.
## Good to Know
- TypeScript tries to infer correct types based on your code automatically, but it is not fully familiar with the way how ServiceNow
creates objects and injects global variables. Hence, it may report false-positive errors in certain cases.
- At the same time, when TypeScript is unable to determine the correct type, it will infer it as type `any` and will not run any type checks on it.
- TypeScript does recognize basic JSDoc comments. If you want to be specific about type parameters or return types, you can optionally comment them with JSDoc, e.g.:
```javascript
/**
A function with exact GlideRecord types
@param {GlideRecord} asset
@param {GlideRecord} user
*/
function setAssetAssignedTo(asset, user) {
asset.setValue("assigned_to", user.getValue("sys_id"));
}
/**
A function accepting generic GlideRecord
@param {GlideRecord} record
@param {string} username
@returns {boolean}
*/
function isAssetCreatedByUser(record, username) {
return record.getValue("sys_created_by") === username;
}
```
- The current TypeScript setting for the generate files is rather strict and is subject to further tuning