Clean up API

This commit is contained in:
Dolan
2018-08-07 01:25:28 +01:00
parent ca8f331eec
commit 12c8cb93f6
21 changed files with 95 additions and 49 deletions

View File

@ -12,6 +12,51 @@
* Follow the `TSLint` rules
## Add vs Create
This is just a guideline, and the rules can sometimes be broken.
* Use `create` if the method `new`'s up an element inside:
```js
public createParagraph() {
const paragraph = new Paragraph();
this.root.push(paragraph);
}
```
* Use `add` if you add the element into the method as a parameter:
```js
public createParagraph(paragraph: Paragraph) {
this.root.push(paragraph);
}
```
## Getters and Setters
Getters and Setters are done with a capital letter like so:
```js
public get Level() {
}
```
There is no performance advantage by doing this. It means we don't need to prefix all private variables with the ugly `_`:
**Do not:**
```js
private get _level: string;
```
**Do**
```js
private get level: string;
```
## Testing
Please write a test of every file you make and suffix it with `.spec.ts`.

View File

@ -37,8 +37,8 @@ Also all the supported section properties are implemented according to: http://o
// Add new section with another header and footer
doc.addSection({
headerId: header.Header.referenceId,
footerId: footer.Footer.referenceId,
headerId: header.Header.ReferenceId,
footerId: footer.Footer.ReferenceId,
pageNumberStart: 1,
pageNumberFormatType: docx.PageNumberFormat.DECIMAL,
});