Skip to content
Permalink
Browse files

Fixed more optional parameter documentation. Sadly, ServiceNow doesn'…

…t properly indicate when a param is optional, so strict IDEs will bitch about them.

Also updated some other shit, I dunno. Commit messages are for sissies.
JUST DOWNLOAD IT, YOU WUSS, IT'S PROBABLY FINE MAYBE! <3
  • Loading branch information...
thisnameissoclever committed Aug 1, 2019
1 parent 3ac2785 commit 7b9f325934c45654c5942c34a08fe9e655af5a8d
Showing with 9 additions and 7 deletions.
  1. +2 −0 ES6/GlideDateTime.js
  2. +1 −1 ES6/GlideRecord.js
  3. +5 −5 ES6/GlideSystem.js
  4. +1 −1 ES6/RESTAPIRequest.js
@@ -3,12 +3,14 @@
* GlideDateTime objects, such as instantiating GlideDateTime objects or working with
* glide_date_time fields.
* @class GlideDateTime
* @interface
* @typedef {Object} GlideDateTime
*/
class GlideDateTime {
/**
* Instantiates a new GlideDateTime object with the current date and time in Greenwich
* Mean Time (GMT).
* @interface
*/
constructor() {}
/**
@@ -391,7 +391,7 @@ export class GlideRecord {
* Retrieves a link to the current record.
* @param {Boolean} [noStack] If true, the sysparm_stack parameter is not appended to the link. The parameter
* sysparm_stack specifies the page to visit after closing the current link.
* @returns A link to the current record as a string.
* @returns {String} A link to the current record as a string.
* @example gr = new GlideRecord('incident');
* gr.addActiveQuery();
* gr.addQuery("priority", 1);
@@ -234,11 +234,11 @@ class GlideSystem {
/**
* Writes an error message to the system log.
* @param {String} message The log message with place holders for any variable arguments.
* @param {Object} param1 (Optional) First variable argument.
* @param {Object} param2 (Optional) Second variable argument.
* @param {Object} param3 (Optional) Third variable argument.
* @param {Object} param4 (Optional) Fourth variable argument.
* @param {Object} param5 (Optional) Fifth variable argument.
* @param {Object} [param1] (Optional) First variable argument.
* @param {Object} [param2] (Optional) Second variable argument.
* @param {Object} [param3] (Optional) Third variable argument.
* @param {Object} [param4] (Optional) Fourth variable argument.
* @param {Object} [param5] (Optional) Fifth variable argument.
* @returns Method does not return a value
* @example gs.error("This is an error message");
* var myFirstName = "Abel";
@@ -10,7 +10,7 @@ class RESTAPIRequest {
* Returns the value of a specific header from the web service request.
* @param {String} header The name of the header, such as accept or
* content-type.
* @returns The value of the specified header.
* @returns {string} The value of the specified header.
* @example var acceptHeader = request.getHeader('accept');
*/
getHeader(header) {}

0 comments on commit 7b9f325

Please sign in to comment.
You can’t perform that action at this time.