Manual
Reference
Source
Installation Guide
Migration Guide: Moving from v2 to v3
Server Class
GSF.Server is now GSF.Client.
Client.APIRoot no longer defaults to 'ese'.
Service Class
Service.info() no longer contains task list.
Service.taskInfoList() response changed.
Task Class
Task.info() response changed.
Task.submit() and Task.submitAndWait() options changed.
Job Class
Job.info() response changed.
Job event names changed. They are now the same as the Client events.
Job.wait() response changed.
Types
TaskInfo
Example of TaskInfo in v2
Example of TaskInfo in v3
ServiceInfo
Example of ServiceInfo in v2
Example of ServiceInfo in v3
SubmitOptions
Example of SubmitOptions in v2
Example of SubmitOptions in v3
JobInfo
Example of JobInfo in v2
Example of JobInfo in v3
JobResults
Example of JobResults in v2
Example of JobResults in v3
Migration Guide: Moving from v3 to v4
Job IDs
Job Lists
New 'query' option
New 'sort' option
New 'totals' option
JobInfoList response has changed
The 'reverse' and 'status' options have been removed
Converting code that uses the 'reverse' option
Converting code that uses the 'status' option
Getting Started
GSF JavaScript Client SDK
About the SDK
Basic Usage
Importing the SDK
Using ECMAScript 2015
Using Node.js
Including the SDK with a Script Tag
Requirements
Server Sent Events
Building the SDK
Testing the SDK
Using a Test Server
Run tests in the browser against mock server.
Run tests in Node.js against mock server.
Building the Documentation
Examples
List Available Services
List Jobs
The 'query' option
The 'sort' option
Advanced query
List Available Tasks
Get Task Information
Run a Task
Using Promises
1. Use .submit() and then .wait()
2. Use .submitAndWait()
List and Retrieve Workspace Files
Using Server Events
Tracking Job Progress
Progress Callbacks
Progress Events
Client Progress Events
Job Progress Events
Cancelling Jobs
Typescript Example
Best Practices
Connecting to Servers
Change Log
4.2.0 / 2021-10-26
New Features
4.0.0 / 2020-06-22
New Features
Breaking Changes
3.0.0 / 2018-03-21
New Features
Breaking Changes
2.2.0 / 2018-03-22
New Features
Bug Fixes
2.1.0 / 2018-03-21
New Features
2.0.0 / 2017-07-24
New Features
Breaking Changes
1.0.0 / 2017-02-26
New Features
Installation Guide
The SDK can be installed using
npm
.
$ npm install gsf-js-client-sdk
Manual
Reference
Source
Manual
Reference
Source