Options
All
  • Public
  • Public/Protected
  • All
Menu

name-of-project - v0.0.1

name-of-project

Documentation

https://docs.amaze360.nl/name-of-project

Issues

issues@example.com

Github Repository

https://git.amaze360.nl/360/name-of-project

Install

npm install git+ssh://git@gitlab.amaze-escape.com/360/name-of-project.git

Upgrade

npm upgrade git+ssh://git@gitlab.amaze-escape.com/360/name-of-project.git

Naming Convention

Style Category
UpperCamelCase class / interface / type / enum / decorator / type parameters
lowerCamelCase variable / parameter / function / method / property / module alias
CONSTANT_CASE global constant values, including enum values
#ident private identifier, we don't use 'private/public'

Documentation Convention

Category Comments
Private all private categories, should be ignored (unless relevant to end user)
Public names of public categories should be self explanatory. Only add additional info if the name cannot describe the purpose
Classes public classes should contain (a link to) a minimal working example

Consume bundle.js

Bundle.js

HTML

<html>
<head>
</head>
<body>
<!-- HTML code goes here -->
<!-- Include JS -->
<script src="path/to/my-project/lib/bundle.js"></script>
</body>
</html>

JS

const MC = new window.MyProject.MyClass();

Generated using TypeDoc