node-poweredup 6.11.0 → 8.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.drone.yml +1 -0
- package/.gitmodules +3 -0
- package/{jsdoc.conf.json → .jsdoc.json} +14 -1
- package/README.md +47 -42
- package/dist/browser/poweredup.js +1 -1
- package/dist/browser/poweredup.js.map +1 -1
- package/dist/node/color.d.ts +6 -0
- package/dist/node/color.js +38 -0
- package/dist/node/color.js.map +1 -0
- package/dist/node/consts.d.ts +48 -27
- package/dist/node/consts.js +53 -31
- package/dist/node/consts.js.map +1 -1
- package/dist/node/devices/absolutemotor.js +6 -6
- package/dist/node/devices/absolutemotor.js.map +1 -1
- package/dist/node/devices/basicmotor.js +2 -2
- package/dist/node/devices/basicmotor.js.map +1 -1
- package/dist/node/devices/colordistancesensor.d.ts +11 -0
- package/dist/node/devices/colordistancesensor.js +95 -2
- package/dist/node/devices/colordistancesensor.js.map +1 -1
- package/dist/node/devices/device.js +2 -0
- package/dist/node/devices/device.js.map +1 -1
- package/dist/node/devices/duplotrainbasecolorsensor.d.ts +2 -1
- package/dist/node/devices/duplotrainbasecolorsensor.js +15 -2
- package/dist/node/devices/duplotrainbasecolorsensor.js.map +1 -1
- package/dist/node/devices/light.js +1 -1
- package/dist/node/devices/light.js.map +1 -1
- package/dist/node/devices/tachomotor.js +6 -6
- package/dist/node/devices/tachomotor.js.map +1 -1
- package/dist/node/devices/technic3x3colorlightmatrix.d.ts +22 -0
- package/dist/node/devices/technic3x3colorlightmatrix.js +77 -0
- package/dist/node/devices/technic3x3colorlightmatrix.js.map +1 -0
- package/dist/node/devices/techniccolorsensor.js +2 -1
- package/dist/node/devices/techniccolorsensor.js.map +1 -1
- package/dist/node/devices/technicmediumhubtiltsensor.d.ts +25 -1
- package/dist/node/devices/technicmediumhubtiltsensor.js +70 -2
- package/dist/node/devices/technicmediumhubtiltsensor.js.map +1 -1
- package/dist/node/devices/technicsmallangularmotor.d.ts +12 -0
- package/dist/node/devices/technicsmallangularmotor.js +35 -0
- package/dist/node/devices/technicsmallangularmotor.js.map +1 -0
- package/dist/node/hubs/basehub.js +4 -0
- package/dist/node/hubs/basehub.js.map +1 -1
- package/dist/node/hubs/hub.js +1 -1
- package/dist/node/hubs/hub.js.map +1 -1
- package/dist/node/hubs/lpf2hub.js +20 -19
- package/dist/node/hubs/lpf2hub.js.map +1 -1
- package/dist/node/hubs/movehub.js +1 -1
- package/dist/node/hubs/movehub.js.map +1 -1
- package/dist/node/hubs/technicmediumhub.js +1 -1
- package/dist/node/hubs/technicmediumhub.js.map +1 -1
- package/dist/node/hubs/technicsmallhub.d.ts +18 -0
- package/dist/node/hubs/technicsmallhub.js +64 -0
- package/dist/node/hubs/technicsmallhub.js.map +1 -0
- package/dist/node/index-browser.js +6 -0
- package/dist/node/index-browser.js.map +1 -1
- package/dist/node/index-node.d.ts +4 -1
- package/dist/node/index-node.js +7 -1
- package/dist/node/index-node.js.map +1 -1
- package/dist/node/poweredup-browser.js +8 -1
- package/dist/node/poweredup-browser.js.map +1 -1
- package/dist/node/poweredup-node.js +30 -1
- package/dist/node/poweredup-node.js.map +1 -1
- package/dist/node/utils.d.ts +1 -1
- package/dist/node/utils.js +10 -3
- package/dist/node/utils.js.map +1 -1
- package/docs/AbsoluteMotor.html +1220 -1405
- package/docs/BaseHub.html +787 -872
- package/docs/BasicMotor.html +923 -1078
- package/docs/ColorDistanceSensor.html +2188 -1540
- package/docs/CurrentSensor.html +711 -800
- package/docs/Device.html +574 -665
- package/docs/DuploTrainBase.html +1255 -1375
- package/docs/DuploTrainBaseColorSensor.html +1049 -978
- package/docs/DuploTrainBaseMotor.html +958 -1113
- package/docs/DuploTrainBaseSpeaker.html +793 -916
- package/docs/DuploTraniBaseSpeedometer.html +628 -719
- package/docs/Hub.html +5621 -2397
- package/docs/HubLED.html +831 -944
- package/docs/LPF2Hub.html +1215 -1335
- package/docs/Light.html +831 -944
- package/docs/Mario.html +1255 -1420
- package/docs/MarioAccelerometer.html +834 -911
- package/docs/MarioBarcodeSensor.html +834 -911
- package/docs/MarioPantsSensor.html +711 -800
- package/docs/MediumLinearMotor.html +861 -1000
- package/docs/MotionSensor.html +711 -800
- package/docs/MoveHub.html +1255 -1420
- package/docs/MoveHubMediumLinearMotor.html +861 -1000
- package/docs/MoveHubTiltSensor.html +730 -814
- package/docs/PiezoBuzzer.html +732 -834
- package/docs/PoweredUP.html +4322 -0
- package/docs/RemoteControl.html +1255 -1420
- package/docs/RemoteControlButton.html +711 -800
- package/docs/SimpleMediumLinearMotor.html +628 -719
- package/docs/TachoMotor.html +1644 -1835
- package/docs/Technic3x3ColorLightMatrix.html +1181 -0
- package/docs/TechnicColorSensor.html +1008 -1099
- package/docs/TechnicDistanceSensor.html +939 -1027
- package/docs/TechnicForceSensor.html +883 -968
- package/docs/TechnicLargeAngularMotor.html +1254 -1439
- package/docs/TechnicLargeLinearMotor.html +1254 -1439
- package/docs/TechnicMediumAngularMotor.html +1254 -1439
- package/docs/TechnicMediumHub.html +1255 -1420
- package/docs/TechnicMediumHubAccelerometerSensor.html +749 -828
- package/docs/TechnicMediumHubGyroSensor.html +749 -828
- package/docs/TechnicMediumHubTiltSensor.html +1340 -831
- package/docs/TechnicSmallAngularMotor.html +2073 -0
- package/docs/TechnicXLargeLinearMotor.html +1254 -1439
- package/docs/TiltSensor.html +730 -814
- package/docs/TrainMotor.html +958 -1113
- package/docs/VoltageSensor.html +711 -800
- package/docs/WeDo2SmartHub.html +1112 -1221
- package/docs/consts.js.html +791 -0
- package/docs/devices_absolutemotor.js.html +95 -197
- package/docs/devices_basicmotor.js.html +91 -193
- package/docs/devices_colordistancesensor.js.html +184 -193
- package/docs/devices_currentsensor.js.html +89 -191
- package/docs/devices_device.js.html +91 -191
- package/docs/devices_duplotrainbasecolorsensor.js.html +104 -193
- package/docs/devices_duplotrainbasemotor.js.html +92 -194
- package/docs/devices_duplotrainbasespeaker.js.html +89 -191
- package/docs/devices_duplotrainbasespeedometer.js.html +89 -191
- package/docs/devices_hubled.js.html +89 -191
- package/docs/devices_light.js.html +90 -192
- package/docs/devices_marioaccelerometer.js.html +89 -191
- package/docs/devices_mariobarcodesensor.js.html +89 -191
- package/docs/devices_mariopantssensor.js.html +89 -191
- package/docs/devices_mediumlinearmotor.js.html +92 -194
- package/docs/devices_motionsensor.js.html +89 -191
- package/docs/devices_movehubmediumlinearmotor.js.html +92 -194
- package/docs/devices_movehubtiltsensor.js.html +89 -191
- package/docs/devices_piezobuzzer.js.html +89 -191
- package/docs/devices_remotecontrolbutton.js.html +89 -191
- package/docs/devices_simplemediumlinearmotor.js.html +92 -194
- package/docs/devices_tachomotor.js.html +95 -197
- package/docs/devices_technic3x3colorlightmatrix.js.html +190 -0
- package/docs/devices_techniccolorsensor.js.html +91 -192
- package/docs/devices_technicdistancesensor.js.html +89 -191
- package/docs/devices_technicforcesensor.js.html +89 -191
- package/docs/devices_techniclargeangularmotor.js.html +92 -194
- package/docs/devices_techniclargelinearmotor.js.html +92 -194
- package/docs/devices_technicmediumangularmotor.js.html +92 -194
- package/docs/devices_technicmediumhubaccelerometersensor.js.html +89 -191
- package/docs/devices_technicmediumhubgyrosensor.js.html +89 -191
- package/docs/devices_technicmediumhubtiltsensor.js.html +159 -193
- package/docs/devices_technicsmallangularmotor.js.html +148 -0
- package/docs/devices_technicxlargelinearmotor.js.html +92 -194
- package/docs/devices_tiltsensor.js.html +89 -191
- package/docs/devices_trainmotor.js.html +92 -194
- package/docs/devices_voltagesensor.js.html +89 -191
- package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Bold-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
- package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
- package/docs/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
- package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Italic-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
- package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Light-webfont.svg +1831 -0
- package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
- package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
- package/docs/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
- package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
- package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Regular-webfont.svg +1831 -0
- package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
- package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
- package/docs/fonts/OpenSans-Semibold-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
- package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
- package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
- package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +1830 -0
- package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
- package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
- package/docs/global.html +9829 -0
- package/docs/hubs_basehub.js.html +93 -191
- package/docs/hubs_duplotrainbase.js.html +89 -191
- package/docs/hubs_hub.js.html +90 -192
- package/docs/hubs_lpf2hub.js.html +109 -210
- package/docs/hubs_mario.js.html +89 -191
- package/docs/hubs_movehub.js.html +90 -192
- package/docs/hubs_remotecontrol.js.html +89 -191
- package/docs/hubs_technicmediumhub.js.html +90 -192
- package/docs/hubs_technicsmallhub.js.html +177 -0
- package/docs/hubs_wedo2smarthub.js.html +89 -191
- package/docs/icons/home.svg +4 -0
- package/docs/icons/search.svg +4 -0
- package/docs/index.html +143 -236
- package/docs/poweredup-browser.js.html +348 -0
- package/docs/poweredup-node.js.html +314 -0
- package/docs/scripts/linenumber.js +23 -0
- package/docs/scripts/pagelocation.js +89 -0
- package/docs/styles/collapse.css +27 -0
- package/docs/styles/jsdoc-default.css +953 -0
- package/docs/styles/prettify-jsdoc.css +111 -0
- package/docs/styles/prettify-tomorrow.css +15 -9
- package/jsdoc-template/braintree/CHANGELOG.md +31 -0
- package/jsdoc-template/braintree/LICENSE +27 -0
- package/jsdoc-template/braintree/README.md +90 -0
- package/jsdoc-template/braintree/package.json +39 -0
- package/jsdoc-template/braintree/publish.js +675 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Bold-webfont.eot +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Bold-webfont.svg +1830 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Bold-webfont.woff +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Italic-webfont.eot +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Italic-webfont.svg +1830 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Italic-webfont.woff +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Light-webfont.eot +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Light-webfont.svg +1831 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Light-webfont.woff +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-LightItalic-webfont.eot +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-LightItalic-webfont.woff +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Regular-webfont.eot +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Regular-webfont.svg +1831 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Regular-webfont.woff +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Semibold-webfont.eot +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Semibold-webfont.svg +1830 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Semibold-webfont.ttf +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-Semibold-webfont.woff +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-SemiboldItalic-webfont.svg +1830 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
- package/jsdoc-template/braintree/static/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
- package/jsdoc-template/braintree/static/icons/home.svg +4 -0
- package/jsdoc-template/braintree/static/icons/search.svg +4 -0
- package/jsdoc-template/braintree/static/scripts/linenumber.js +23 -0
- package/jsdoc-template/braintree/static/scripts/pagelocation.js +89 -0
- package/jsdoc-template/braintree/static/styles/collapse.css +27 -0
- package/jsdoc-template/braintree/static/styles/jsdoc-default.css +953 -0
- package/jsdoc-template/braintree/static/styles/prettify-jsdoc.css +111 -0
- package/jsdoc-template/braintree/static/styles/prettify-tomorrow.css +138 -0
- package/jsdoc-template/braintree/tmpl/augments.tmpl +10 -0
- package/jsdoc-template/braintree/tmpl/container.tmpl +213 -0
- package/jsdoc-template/braintree/tmpl/details.tmpl +223 -0
- package/jsdoc-template/braintree/tmpl/example.tmpl +2 -0
- package/jsdoc-template/braintree/tmpl/examples.tmpl +14 -0
- package/jsdoc-template/braintree/tmpl/exceptions.tmpl +28 -0
- package/jsdoc-template/braintree/tmpl/layout.tmpl +150 -0
- package/jsdoc-template/braintree/tmpl/mainpage.tmpl +9 -0
- package/jsdoc-template/braintree/tmpl/members.tmpl +38 -0
- package/jsdoc-template/braintree/tmpl/method.tmpl +128 -0
- package/jsdoc-template/braintree/tmpl/params.tmpl +125 -0
- package/jsdoc-template/braintree/tmpl/properties.tmpl +111 -0
- package/jsdoc-template/braintree/tmpl/returns.tmpl +17 -0
- package/jsdoc-template/braintree/tmpl/source.tmpl +9 -0
- package/jsdoc-template/braintree/tmpl/tutorial.tmpl +23 -0
- package/jsdoc-template/braintree/tmpl/type.tmpl +11 -0
- package/package.json +14 -15
- package/src/color.ts +20 -0
- package/src/consts.ts +47 -26
- package/src/devices/colordistancesensor.ts +98 -3
- package/src/devices/device.ts +1 -0
- package/src/devices/duplotrainbasecolorsensor.ts +17 -2
- package/src/devices/technic3x3colorlightmatrix.ts +64 -0
- package/src/devices/techniccolorsensor.ts +2 -1
- package/src/devices/technicmediumhubtiltsensor.ts +75 -3
- package/src/devices/technicsmallangularmotor.ts +17 -0
- package/src/hubs/basehub.ts +4 -0
- package/src/hubs/lpf2hub.ts +8 -9
- package/src/hubs/technicmediumhub.ts +1 -1
- package/src/hubs/technicsmallhub.ts +60 -0
- package/src/index-browser.ts +6 -0
- package/src/index-node.ts +6 -0
- package/src/poweredup-browser.ts +8 -1
- package/src/poweredup-node.ts +9 -1
- package/src/utils.ts +7 -0
- package/docs/classes.list.html +0 -8654
- package/docs/fonts/glyphicons-halflings-regular.eot +0 -0
- package/docs/fonts/glyphicons-halflings-regular.svg +0 -288
- package/docs/fonts/glyphicons-halflings-regular.ttf +0 -0
- package/docs/fonts/glyphicons-halflings-regular.woff +0 -0
- package/docs/fonts/glyphicons-halflings-regular.woff2 +0 -0
- package/docs/img/glyphicons-halflings-white.png +0 -0
- package/docs/img/glyphicons-halflings.png +0 -0
- package/docs/quicksearch.html +0 -31
- package/docs/scripts/docstrap.lib.js +0 -11
- package/docs/scripts/fulltext-search-ui.js +0 -89
- package/docs/scripts/fulltext-search.js +0 -36
- package/docs/scripts/lunr.min.js +0 -6
- package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
- package/docs/scripts/prettify/jquery.min.js +0 -6
- package/docs/scripts/prettify/lang-css.js +0 -21
- package/docs/scripts/prettify/prettify.js +0 -496
- package/docs/scripts/sunlight.js +0 -1157
- package/docs/scripts/toc.js +0 -203
- package/docs/styles/darkstrap.css +0 -960
- package/docs/styles/site.cerulean.css +0 -7008
- package/docs/styles/site.cosmo.css +0 -7061
- package/docs/styles/site.cyborg.css +0 -7048
- package/docs/styles/site.darkly.css +0 -7171
- package/docs/styles/site.darkstrap.css +0 -5638
- package/docs/styles/site.dibs-bootstrap.css +0 -5899
- package/docs/styles/site.flatly.css +0 -7147
- package/docs/styles/site.journal.css +0 -6973
- package/docs/styles/site.lumen.css +0 -7298
- package/docs/styles/site.paper.css +0 -7623
- package/docs/styles/site.readable.css +0 -6997
- package/docs/styles/site.sandstone.css +0 -7035
- package/docs/styles/site.simplex.css +0 -7023
- package/docs/styles/site.slate.css +0 -7343
- package/docs/styles/site.spacelab.css +0 -7055
- package/docs/styles/site.superhero.css +0 -7131
- package/docs/styles/site.united.css +0 -6895
- package/docs/styles/site.yeti.css +0 -7195
- package/docs/styles/sunlight.dark.css +0 -345
- package/docs/styles/sunlight.default.css +0 -344
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
/* JSDoc prettify.js theme */
|
|
2
|
+
|
|
3
|
+
/* plain text */
|
|
4
|
+
.pln {
|
|
5
|
+
color: #000000;
|
|
6
|
+
font-weight: normal;
|
|
7
|
+
font-style: normal;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
/* string content */
|
|
11
|
+
.str {
|
|
12
|
+
color: hsl(104, 100%, 24%);
|
|
13
|
+
font-weight: normal;
|
|
14
|
+
font-style: normal;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/* a keyword */
|
|
18
|
+
.kwd {
|
|
19
|
+
color: #000000;
|
|
20
|
+
font-weight: bold;
|
|
21
|
+
font-style: normal;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/* a comment */
|
|
25
|
+
.com {
|
|
26
|
+
font-weight: normal;
|
|
27
|
+
font-style: italic;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/* a type name */
|
|
31
|
+
.typ {
|
|
32
|
+
color: #000000;
|
|
33
|
+
font-weight: normal;
|
|
34
|
+
font-style: normal;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/* a literal value */
|
|
38
|
+
.lit {
|
|
39
|
+
color: #006400;
|
|
40
|
+
font-weight: normal;
|
|
41
|
+
font-style: normal;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/* punctuation */
|
|
45
|
+
.pun {
|
|
46
|
+
color: #000000;
|
|
47
|
+
font-weight: bold;
|
|
48
|
+
font-style: normal;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/* lisp open bracket */
|
|
52
|
+
.opn {
|
|
53
|
+
color: #000000;
|
|
54
|
+
font-weight: bold;
|
|
55
|
+
font-style: normal;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/* lisp close bracket */
|
|
59
|
+
.clo {
|
|
60
|
+
color: #000000;
|
|
61
|
+
font-weight: bold;
|
|
62
|
+
font-style: normal;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/* a markup tag name */
|
|
66
|
+
.tag {
|
|
67
|
+
color: #006400;
|
|
68
|
+
font-weight: normal;
|
|
69
|
+
font-style: normal;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/* a markup attribute name */
|
|
73
|
+
.atn {
|
|
74
|
+
color: #006400;
|
|
75
|
+
font-weight: normal;
|
|
76
|
+
font-style: normal;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
/* a markup attribute value */
|
|
80
|
+
.atv {
|
|
81
|
+
color: #006400;
|
|
82
|
+
font-weight: normal;
|
|
83
|
+
font-style: normal;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/* a declaration */
|
|
87
|
+
.dec {
|
|
88
|
+
color: #000000;
|
|
89
|
+
font-weight: bold;
|
|
90
|
+
font-style: normal;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
/* a variable name */
|
|
94
|
+
.var {
|
|
95
|
+
color: #000000;
|
|
96
|
+
font-weight: normal;
|
|
97
|
+
font-style: normal;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/* a function name */
|
|
101
|
+
.fun {
|
|
102
|
+
color: #000000;
|
|
103
|
+
font-weight: bold;
|
|
104
|
+
font-style: normal;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/* Specify class=linenums on a pre to get line numbering */
|
|
108
|
+
ol.linenums {
|
|
109
|
+
margin-top: 0;
|
|
110
|
+
margin-bottom: 0;
|
|
111
|
+
}
|
|
@@ -9,35 +9,35 @@
|
|
|
9
9
|
@media screen {
|
|
10
10
|
/* string content */
|
|
11
11
|
.str {
|
|
12
|
-
color:
|
|
12
|
+
color: hsl(104, 100%, 24%); }
|
|
13
13
|
|
|
14
14
|
/* a keyword */
|
|
15
15
|
.kwd {
|
|
16
|
-
color:
|
|
16
|
+
color: hsl(240, 100%, 50%); }
|
|
17
17
|
|
|
18
18
|
/* a comment */
|
|
19
19
|
.com {
|
|
20
|
-
color:
|
|
20
|
+
color: hsl(0, 0%, 60%); }
|
|
21
21
|
|
|
22
22
|
/* a type name */
|
|
23
23
|
.typ {
|
|
24
|
-
color:
|
|
24
|
+
color: hsl(240, 100%, 32%); }
|
|
25
25
|
|
|
26
26
|
/* a literal value */
|
|
27
27
|
.lit {
|
|
28
|
-
color:
|
|
28
|
+
color: hsl(240, 100%, 40%); }
|
|
29
29
|
|
|
30
30
|
/* punctuation */
|
|
31
31
|
.pun {
|
|
32
|
-
color: #
|
|
32
|
+
color: #000000; }
|
|
33
33
|
|
|
34
34
|
/* lisp open bracket */
|
|
35
35
|
.opn {
|
|
36
|
-
color: #
|
|
36
|
+
color: #000000; }
|
|
37
37
|
|
|
38
38
|
/* lisp close bracket */
|
|
39
39
|
.clo {
|
|
40
|
-
color: #
|
|
40
|
+
color: #000000; }
|
|
41
41
|
|
|
42
42
|
/* a markup tag name */
|
|
43
43
|
.tag {
|
|
@@ -98,13 +98,19 @@
|
|
|
98
98
|
/*
|
|
99
99
|
pre.prettyprint {
|
|
100
100
|
background: white;
|
|
101
|
-
font-family:
|
|
101
|
+
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
|
102
102
|
font-size: 12px;
|
|
103
103
|
line-height: 1.5;
|
|
104
104
|
border: 1px solid #ccc;
|
|
105
105
|
padding: 10px; }
|
|
106
106
|
*/
|
|
107
107
|
|
|
108
|
+
/* Get LI elements to show when they are in the main article */
|
|
109
|
+
article ul li {
|
|
110
|
+
list-style-type: circle;
|
|
111
|
+
margin-left: 25px;
|
|
112
|
+
}
|
|
113
|
+
|
|
108
114
|
/* Specify class=linenums on a pre to get line numbering */
|
|
109
115
|
ol.linenums {
|
|
110
116
|
margin-top: 0;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# CHANGELOG
|
|
2
|
+
|
|
3
|
+
## v3.4.0 (2020-10-15)
|
|
4
|
+
|
|
5
|
+
* Added a postprocess function option to template config options
|
|
6
|
+
|
|
7
|
+
## 3.3.0
|
|
8
|
+
|
|
9
|
+
* Added support for templates.collapse option. When set to true only the active component\'s members are expanded.
|
|
10
|
+
* Added templates.resources option that takes an object where the keys are the labels and the values are links to external resources.
|
|
11
|
+
* Minor css bugfixes
|
|
12
|
+
|
|
13
|
+
## 3.2.0
|
|
14
|
+
|
|
15
|
+
* Fix issue where all elements would be hidden if no excludePattern is included ([#16] thanks [@mercmobily])
|
|
16
|
+
* Display bullet points in documentation ([#17]) thanks [@mercmobily])
|
|
17
|
+
* Allow `disableSort` to be included in template to prevent automatic sorting of classes and methods ([#15] thanks [@mercmobily])
|
|
18
|
+
|
|
19
|
+
## 3.1.1
|
|
20
|
+
|
|
21
|
+
* Hide hidden modules from members section
|
|
22
|
+
|
|
23
|
+
## 3.1.0
|
|
24
|
+
|
|
25
|
+
* Add anchor tags to examples
|
|
26
|
+
* Increase max-width of sections
|
|
27
|
+
|
|
28
|
+
[@mercmobily]: /mercmobily/
|
|
29
|
+
[#15]: /braintree/jsdoc-template/pull/15
|
|
30
|
+
[#16]: /braintree/jsdoc-template/pull/16
|
|
31
|
+
[#17]: /braintree/jsdoc-template/pull/17
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## JSDoc 3
|
|
2
|
+
|
|
3
|
+
JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
|
|
4
|
+
"License"). Commercial and non-commercial use are permitted in compliance with
|
|
5
|
+
the License.
|
|
6
|
+
|
|
7
|
+
Copyright (c) 2011-2015 Michael Mathews <micmath@gmail.com> and the
|
|
8
|
+
[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
|
|
9
|
+
All rights reserved.
|
|
10
|
+
|
|
11
|
+
You may obtain a copy of the License at:
|
|
12
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
13
|
+
|
|
14
|
+
In addition, a copy of the License is included with this distribution.
|
|
15
|
+
|
|
16
|
+
As stated in Section 7, "Disclaimer of Warranty," of the License:
|
|
17
|
+
|
|
18
|
+
> Licensor provides the Work (and each Contributor provides its Contributions)
|
|
19
|
+
> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
|
20
|
+
> express or implied, including, without limitation, any warranties or
|
|
21
|
+
> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
22
|
+
> PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
23
|
+
> appropriateness of using or redistributing the Work and assume any risks
|
|
24
|
+
> associated with Your exercise of permissions under this License.
|
|
25
|
+
|
|
26
|
+
The source code for JSDoc 3 is available at:
|
|
27
|
+
https://github.com/jsdoc3/jsdoc
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
# Braintree JSDoc Template
|
|
2
|
+
|
|
3
|
+
A clean, responsive documentation template with search and navigation highlighting for JSDoc 3. Forked from [github.com/nijikokun/minami](https://github.com/nijikokun/minami).
|
|
4
|
+
|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
## Responsive
|
|
8
|
+
|
|
9
|
+

|
|
10
|
+
|
|
11
|
+
## Uses
|
|
12
|
+
|
|
13
|
+
- [the Taffy Database library](http://taffydb.com/)
|
|
14
|
+
- [Underscore Template library](http://documentcloud.github.com/underscore/#template)
|
|
15
|
+
- [Algolia DocSearch](https://community.algolia.com/docsearch/)
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
Clone repository to your designated `jsdoc` template directory, then:
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Node.js Dependency
|
|
23
|
+
|
|
24
|
+
In your projects `package.json` file add a generate script:
|
|
25
|
+
|
|
26
|
+
```json
|
|
27
|
+
"script": {
|
|
28
|
+
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
In your `.jsdoc.json` file, add a template option.
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
"opts": {
|
|
36
|
+
"template": "node_modules/jsdoc-template"
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Example JSDoc Config
|
|
41
|
+
|
|
42
|
+
```json
|
|
43
|
+
{
|
|
44
|
+
"tags": {
|
|
45
|
+
"allowUnknownTags": true,
|
|
46
|
+
"dictionaries": ["jsdoc"]
|
|
47
|
+
},
|
|
48
|
+
"source": {
|
|
49
|
+
"include": ["lib", "package.json", "README.md"],
|
|
50
|
+
"includePattern": ".js$",
|
|
51
|
+
"excludePattern": "(node_modules/|docs)"
|
|
52
|
+
},
|
|
53
|
+
"plugins": [
|
|
54
|
+
"plugins/markdown"
|
|
55
|
+
],
|
|
56
|
+
"templates": {
|
|
57
|
+
"referenceTitle": "My SDK Name",
|
|
58
|
+
"disableSort": false,
|
|
59
|
+
"collapse": true,
|
|
60
|
+
"resources": {
|
|
61
|
+
"google": "https://www.google.com/"
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
"opts": {
|
|
65
|
+
"destination": "./docs/",
|
|
66
|
+
"encoding": "utf8",
|
|
67
|
+
"private": true,
|
|
68
|
+
"recurse": true,
|
|
69
|
+
"template": "./node_modules/jsdoc-template"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Note: `referenceTitle` and `disableSort` will affect the output of this theme.
|
|
75
|
+
|
|
76
|
+
If you would like to enable [Algolia DocSearch](https://community.algolia.com/docsearch/), you can pass a `search` object into the `templates` object.
|
|
77
|
+
|
|
78
|
+
```json
|
|
79
|
+
"templates": {
|
|
80
|
+
"search": {
|
|
81
|
+
"apiKey": "your-api-key",
|
|
82
|
+
"indexName": "Your index name. Defaults to braintree.",
|
|
83
|
+
"hitsPerPage": "Number of Results to show. Defaults to 7.",
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## License
|
|
89
|
+
|
|
90
|
+
Licensed under the Apache2 license.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "jsdoc-template",
|
|
3
|
+
"version": "3.4.0",
|
|
4
|
+
"description": "Braintree JSDoc 3 Template",
|
|
5
|
+
"main": "publish.js",
|
|
6
|
+
"files": [
|
|
7
|
+
"static",
|
|
8
|
+
"tmpl",
|
|
9
|
+
"publish.js",
|
|
10
|
+
"CHANGELOG.md",
|
|
11
|
+
"LICENSE",
|
|
12
|
+
"README.md"
|
|
13
|
+
],
|
|
14
|
+
"scripts": {
|
|
15
|
+
"lint": "eslint .",
|
|
16
|
+
"test": "npm run lint",
|
|
17
|
+
"preversion": "./scripts/preversion"
|
|
18
|
+
},
|
|
19
|
+
"repository": {
|
|
20
|
+
"type": "git",
|
|
21
|
+
"url": "https://github.com/braintree/jsdoc-template"
|
|
22
|
+
},
|
|
23
|
+
"author": "Braintreeps <code@getbraintree.com>",
|
|
24
|
+
"licenses": [
|
|
25
|
+
{
|
|
26
|
+
"type": "Apache-2.0",
|
|
27
|
+
"url": "http://www.apache.org/licenses/LICENSE-2.0"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"bugs": {
|
|
31
|
+
"url": "https://github.com/braintree/jsdoc-template"
|
|
32
|
+
},
|
|
33
|
+
"homepage": "https://github.com/braintree/jsdoc-template",
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"eslint": "^7.4.0",
|
|
36
|
+
"eslint-config-braintree": "^4.0.0",
|
|
37
|
+
"taffydb": "^2.7.3"
|
|
38
|
+
}
|
|
39
|
+
}
|