taskcluster-client - npm Package Compare versions

Comparing version 0.3.0-alpha to 0.3.0-alpha.1

factory/graph.js

 /**
 @module taskcluster-client/factory/graph
 */
+
+/**
+Create a task graph factory
+@see https://github.com/lightsofapollo/object-factory
+
+@example
+
+var factory = require('taskcluster-client/factory/graph');
+
+factory.create({
+  routing: 'test',
+
+  tasks: {
+    'run a task': {
+      reruns: 0,
+
+      task: {
+        payload: {
+          image: 'ubuntu',
+          command: ['ls']
+        }
+      }
+    }
+  }
+});
+
+@example
+
+// example output from a graph create
+
+{ version: '0.2.0',
+  routing: 'test',
+  tasks:
+   { 'run a task':
+      { reruns: 0,
+        task:
+         { version: '0.2.0',
+           provisionerId: 'dont-spawn-machines',
+           routing: '',
+           timeout: 180,
+           retries: 1,
+           priority: 5,
+           payload:
+            { image: 'ubuntu',
+              features: {},
+              command: [ 'ls' ] },
+           metadata:
+            { name: '',
+              description: '',
+              owner: '',
+              source: 'http://localhost' },
+           tags: {},
+           created: Tue Mar 18 2014 03:38:14 GMT-0700 (PDT),
+           deadline: Wed Mar 19 2014 03:38:14 GMT-0700 (PDT) },
+        requires: [] } } }
+
+*/
+exports.create = function create() {};
+
 var Factory = require('object-factory');
@@ -5,0 +64,0 @@ var Task = require('./task');

graph.js

 /**
-@module taskcluster-client/queue
+@module taskcluster-client/graph
 */
@@ -14,9 +14,9 @@
 /**
-HTTP api for the taskcluster queue.
+HTTP api for the taskcluster graph.
 
-@param {Object} options for the queue.
-@param {String} [options.queueUrl].
+@param {Object} options for the graph.
+@param {String} [options.graphUrl].
 @constructor
-@see http://docs.taskcluster.net/queue/api-docs.html
-@alias module:taskcluster-client/queue
+@see http://docs.taskcluster.net/scheduler/api-docs/
+@alias module:taskcluster-client/graph
 */
@@ -31,5 +31,5 @@ function Graph(options) {
   /**
-  @see taskcluster-client/factory/graph
   @param {Object} graph object to insert into.
-    See the graph factory for helpers to generate this.
+    See the {@link module:taskcluster-client/factory/graph|graph factory}
+    for helpers to generate this.
   @return {Promise<Object>} promise for the result of the insertion.
@@ -36,0 +36,0 @@ */

Gruntfile.js

@@ -8,3 +8,5 @@ module.exports = function(grunt) {
     'queue.js',
-    'factory/task.js'
+    'graph.js',
+    'factory/task.js',
+    'factory/graph.js'
   ];
@@ -11,0 +13,0 @@

package.json

 {
   "name": "taskcluster-client",
-  "version": "0.3.0-alpha",
+  "version": "0.3.0-alpha.1",
   "description": "mozilla taskcluster client",
@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29341

increased by4.32%

Lines of code

780

increased by6.85%

No dependency changes