Static class for namespace creation and core utility functions for ScriptX.Services client libraries.
This must be included before any other files from this package.
The implementation is for use in a browser only, not general runtime javascript environments.
This code is necessarily 'old-fashioned' as it may find itself running in old versions of IE.
Members
Methods
# static createNS(namespace) → {object}
Create a namespace
Parameters:
| Name | Type | Description |
|---|---|---|
namespace |
string
|
path of the namespace |
static object for the namespace
object
Example
var ui = MeadCo.createNS("MeadCo.ScriptX.Print.UI");
ui.Show = function() { alert("hello"); }# static error(text)
Marks the content as an error and sends to the console
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string
|
to send to console |
# static log(text)
Sends the content to the console (if informational logging is enabled)
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string
|
to send to console |
# static makeApiEndPoint(serverUrl, apiLocation) → {string}
Get the url to a ScriptX.Services api. If an api is already present, it is replaced.
Parameters:
| Name | Type | Description |
|---|---|---|
serverUrl |
string
|
url to the server |
apiLocation |
string
|
the api, e.g. v1/printhtml |
url to the api
string
# static makeServiceEndPoint(serverUrl, endPoint) → {string}
Get the url to a ScriptX.Services service endpoint.
Parameters:
| Name | Type | Description |
|---|---|---|
serverUrl |
string
|
url to the server |
endPoint |
string
|
the service endpoint, e.g. v1/preview |
url to the endpoint
string
# static parseAjaxError(logText, jqXhr, textStatus, errorThrown) → {string}
Extract the error text from jQuery AJAX response
Parameters:
| Name | Type | Description |
|---|---|---|
logText |
string
|
The lead-in text for a console.log entry |
jqXhr |
object
|
jQuery ajax header |
textStatus |
string
|
textStatus result determined by jQuery |
errorThrown |
string
|
The server exception dewtermined by jQuery |
The error text to display
string
# static parseFetchError(errorThrown) → {string}
Extract the error text from browser fetch response
Parameters:
| Name | Type | Description |
|---|---|---|
errorThrown |
object
|
error caught from fetch |
The error text to display
string
# static warn(text)
Marks the content as a warning and sends to the console
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string
|
to send to console |