0.0.11 • Published 7 years ago
cd-core v0.0.11
cd-core
Common utility and resources (assets)
API
const core = require('cd-core');
core.name (type: string property)
Param | Description |
---|---|
ret ==> | Module Name |
const name = core.name; // returns module name
core.version (type: string property)
Param | Description |
---|---|
ret ==> | Version Number |
const vers = core.version; // returns module version
core.isWindows (type: function)
Param | Description |
---|---|
ret ==> | true or false |
const isWindows = core.isWindows(); // returns true if running on windows
core.isOSX (type: function)
Param | Description |
---|---|
ret ==> | true or false |
const isOSX = core.isOSX(); // returns true if running on osx
core.isLinux (type: function)
Param | Description |
---|---|
ret ==> | true or false |
const isLinux = core.isLinux(); // returns true if running on linux
core.getAssetPath (type: function)
Param | Description |
---|---|
ret ==> | Returns full path to asset path (icons, etc.) |
const assetPath = core.getAssetPath(); // returns core asset path
core.getModuleIcon (type: function)
Param | Description |
---|---|
ret ==> | Returns path to module icon |
const moduleIconPath = core.getModuleIcon(); // returns path to module icon
core.getFailIcon (type: function)
Param | Description |
---|---|
ret ==> | Returns path to fail icon |
const failIconPath = core.getFailIcon(); // returns path to fail icon
core.getPassIcon (type: function)
Param | Description |
---|---|
ret ==> | Returns path to pass icon |
const passIconPath = core.getPassIcon(); // returns path to pass icon
core.notify (type: function)
Param | Description |
---|---|
message | Notification Messasge |
options | Notification Options |
showConsole: true or false | |
icon: path to override icon | |
title: title override |
core.notify('Hello', {showConsole: false}); // display default message and no console output
core.notifyPass (type: function)
Param | Description |
---|---|
message | Notification Message |
options | Notification Options |
showConsole: true or false | |
icon: path to override icon | |
title: title override |
core.notifyPass('Process Completed Successfully'); // display default message
core.notifyFail (type: function)
Param | Description |
---|---|
message | Notification Message |
options | Notification Options |
showConsole: true or false | |
icon: path to override icon | |
title: title override |
core.notifyFail('Process Failed To Complete'); // display default message
License
Copyright © 2017 Mike Erickson Released under the MIT license
Credits
cd-core written by Mike Erickson
E-Mail: codedungeon@gmail.com
Twitter: @codedungeon
Webiste: codedungeon.org
0.0.11
7 years ago
0.0.10
7 years ago
0.0.9
7 years ago
0.0.8
7 years ago
0.0.7
7 years ago
0.0.6
7 years ago
0.0.5
7 years ago
0.0.4
7 years ago
0.0.3
7 years ago
0.0.2
7 years ago
0.0.0-dev.8
7 years ago
0.0.0-dev.7
7 years ago
0.0.0-dev.6
7 years ago
0.0.0-dev.5
7 years ago
0.0.0-dev.4
7 years ago
0.0.0-dev.3
7 years ago
0.0.0-dev.2
7 years ago
0.0.1-dev.1
7 years ago