mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 10:56:53 +00:00
Update aws-iot-device-sdk for version 2.2.0
Lifted documentioned directly from the readme:
https://github.com/aws/aws-iot-device-sdk-js#job
Code change is here:
234d170c86
This commit is contained in:
Colin
parent
8816e2e88c
commit
7c723a81c5
@ -101,3 +101,50 @@ const thingShadows = new awsIot.thingShadow({
|
||||
|
||||
thingShadows.on("timeout", function(thingName: string, clientToken: string) {
|
||||
});
|
||||
|
||||
const jobs = new awsIot.jobs({
|
||||
keyPath: "",
|
||||
certPath: "",
|
||||
caPath: "",
|
||||
clientId: "",
|
||||
region: "",
|
||||
baseReconnectTimeMs: 1000,
|
||||
protocol: "wss",
|
||||
port: 443,
|
||||
host: "",
|
||||
debug: false
|
||||
});
|
||||
|
||||
jobs.subscribeToJobs("thingname", "operationname", (err, job) => {
|
||||
console.error("Error", err);
|
||||
if (err || !job) {
|
||||
return;
|
||||
}
|
||||
console.log("job id", job.id);
|
||||
console.log("job info", job.document);
|
||||
console.log("job op", job.operation);
|
||||
console.log("job status", job.status);
|
||||
console.log("job status details", job.status.statusDetails);
|
||||
console.log(
|
||||
"job status details progress",
|
||||
job.status.statusDetails.progress
|
||||
);
|
||||
|
||||
job.inProgress({ progress: "1" }, err =>
|
||||
console.error("Job progress error", err)
|
||||
);
|
||||
job.failed({ progress: "2" }, err =>
|
||||
console.error("Job failed error", err)
|
||||
);
|
||||
job.succeeded({ progress: "3" }, err =>
|
||||
console.error("Job failed error", err)
|
||||
);
|
||||
});
|
||||
|
||||
jobs.startJobNotifications("thingname", err =>
|
||||
console.error("Start job notification error", err)
|
||||
);
|
||||
|
||||
jobs.unsubscribeFromJobs("thingname", "operationame", err =>
|
||||
console.error("Unsubscribe from jobs error", err)
|
||||
);
|
||||
|
||||
114
types/aws-iot-device-sdk/index.d.ts
vendored
114
types/aws-iot-device-sdk/index.d.ts
vendored
@ -1,4 +1,4 @@
|
||||
// Type definitions for aws-iot-device-sdk 2.1.0
|
||||
// Type definitions for aws-iot-device-sdk 2.2.0
|
||||
// Project: https://github.com/aws/aws-iot-device-sdk-js
|
||||
// Definitions by: Markus Olsson <https://github.com/niik>
|
||||
// Margus Lamp <https://github.com/mlamp>
|
||||
@ -391,3 +391,115 @@ export class thingShadow extends NodeJS.EventEmitter {
|
||||
/** Emitted when a different client"s update or delete operation is accepted on the shadow. */
|
||||
on(event: "foreignStateChange", listener: (thingName: string, operation: "update" | "delete", stateObject: any) => void): this;
|
||||
}
|
||||
|
||||
export interface statusDetails {
|
||||
progress: string;
|
||||
}
|
||||
|
||||
export interface jobStatus {
|
||||
status: string;
|
||||
statusDetails: statusDetails;
|
||||
}
|
||||
|
||||
export interface jobDocument {
|
||||
[key: string]: any
|
||||
}
|
||||
|
||||
export interface job {
|
||||
/** Object that contains job execution information and functions for updating job execution status. */
|
||||
|
||||
/** Returns the job id. */
|
||||
id: string;
|
||||
|
||||
/**
|
||||
* The JSON document describing details of the job to be executed eg.
|
||||
* {
|
||||
* "operation": "install",
|
||||
* "otherProperty": "value",
|
||||
* ...
|
||||
* }
|
||||
*/
|
||||
document: jobDocument;
|
||||
|
||||
/**
|
||||
* Returns the job operation from the job document. Eg. 'install', 'reboot', etc.
|
||||
*/
|
||||
operation: string;
|
||||
|
||||
/**
|
||||
* Returns the current job status according to AWS Orchestra.
|
||||
*/
|
||||
status: jobStatus;
|
||||
|
||||
/**
|
||||
* Update the status of the job execution to be IN_PROGRESS for the thing associated with the job.
|
||||
*
|
||||
* @param statusDetails - optional document describing the status details of the in progress job
|
||||
* @param callback - function(err) optional callback for when the operation completes, err is null if no error occurred
|
||||
*/
|
||||
inProgress(statusDetails?: statusDetails, callback?: (err: Error) => void): void;
|
||||
|
||||
/**
|
||||
* Update the status of the job execution to be FAILED for the thing associated with the job.
|
||||
*
|
||||
* @param statusDetails - optional document describing the status details of the in progress job e.g.
|
||||
* @param callback - function(err) optional callback for when the operation completes, err is null if no error occurred
|
||||
*/
|
||||
failed(statusDetails?: statusDetails, callback?: (err: Error) => void): void;
|
||||
|
||||
/**
|
||||
* Update the status of the job execution to be SUCCESS for the thing associated with the job.
|
||||
*
|
||||
* @param statusDetails - optional document describing the status details of the in progress job e.g.
|
||||
* @param callback - function(err) optional callback for when the operation completes, err is null if no error occurred
|
||||
*/
|
||||
succeeded(statusDetails?: statusDetails, callback?: (err: Error) => void): void;
|
||||
}
|
||||
|
||||
export class jobs extends device {
|
||||
/**
|
||||
* The `jobs` class wraps an instance of the `device` class with additional functionality to
|
||||
* handle job execution management through the AWS IoT Jobs platform. Arguments in `deviceOptions`
|
||||
* are the same as those in the device class and the `jobs` class supports all of the
|
||||
* same events and functions as the `device` class.
|
||||
*/
|
||||
constructor(options?: DeviceOptions);
|
||||
|
||||
/**
|
||||
* Subscribes to job execution notifications for the thing named `thingName`. If
|
||||
* `operationName` is specified then the callback will only be called when a job
|
||||
* ready for execution contains a property called `operation` in its job document with
|
||||
* a value matching `operationName`. If `operationName` is omitted then the callback
|
||||
* will be called for every job ready for execution that does not match another
|
||||
* `subscribeToJobs` subscription.
|
||||
*
|
||||
* @param thingName - name of the Thing to receive job execution notifications
|
||||
* @param operationName - optionally filter job execution notifications to jobs with a value
|
||||
* for the `operation` property that matches `operationName
|
||||
* @param callback - function (err, job) callback for when a job execution is ready for processing or an error occurs
|
||||
* - `err` a subscription error or an error that occurs when client is disconnecting
|
||||
* - `job` an object that contains job execution information and functions for updating job execution status.
|
||||
*/
|
||||
subscribeToJobs(thingName: string, operationName: string, callback?: (err: Error, job: job) => void): void;
|
||||
|
||||
/**
|
||||
* Causes any existing queued job executions for the given thing to be published
|
||||
* to the appropriate subscribeToJobs handler. Only needs to be called once per thing.
|
||||
*
|
||||
* @param thingName - name of the Thing to cancel job execution notifications for
|
||||
* @param callback - function (err) callback for when the startJobNotifications operation completes
|
||||
*/
|
||||
startJobNotifications(thingName: string, callback: (error: Error) => void): mqtt.Client;
|
||||
|
||||
/**
|
||||
* Unsubscribes from job execution notifications for the thing named `thingName` having
|
||||
* operations with a value of the given `operationName`. If `operationName` is omitted then
|
||||
* the default handler for the thing with the given name is unsubscribed.
|
||||
*
|
||||
* @param thingName - name of the Thing to cancel job execution notifications for
|
||||
* @param operationName - optional name of previously subscribed operation names
|
||||
* @param callback - function (err) callback for when the unsubscribe operation completes
|
||||
*/
|
||||
unsubscribeFromJobs(thingName: string, operationName: string, callback: (err: Error) => void): void;
|
||||
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user