0.0.71 • Published 8 months ago
nestdoc v0.0.71
nestdoc
Nest.JS documentation generator
Installation
sudo npm install -g nestdoc
CLI
# Input dir
nestdoc src
# Output dir
--output -o documentation
# Watch mode
--watch -w
# Base url
--base -b '/docs'
# Custom logo
--logo -l 'http://example.com/images/logo.png'
# Custom favicon
--favicon -f 'http://example.com/images/favicon.png'
# Start server
--serve -s
# Server host
--host -h 'localhost'
# Server port
--port -p 3000
Documentation comments
/**
* Service description
*/
@Injectable()
export class MyService {
constructor(
/**
* Property description
*/
private readonly otherService: OtherService,
) {}
/**
* Method description
* @args
* - arg1: Arg 1 description
* - arg2: Arg 2 description
* @returns Return value description
* @example
* const result = await this.myService.myMethod(arg1, arg2);
* @author Author Name <author@email.com>
* @deprecated
* @throws HttpException('Not found!', 404)
* @throws HttpException('Forbidden', 402)
* @todo
* - Issue 1
* - Issue 2
*/
async myMethod(
arg1: number,
arg2: string,
): Promise<MyResult> {
// Method body
}
}
0.0.70
8 months ago
0.0.71
8 months ago
0.0.69
8 months ago
0.0.67
11 months ago
0.0.68
11 months ago
0.0.64
1 year ago
0.0.66
1 year ago
0.0.62
1 year ago
0.0.63
1 year ago
0.0.60
1 year ago
0.0.61
1 year ago
0.0.59
1 year ago
0.0.51
1 year ago
0.0.52
1 year ago
0.0.53
1 year ago
0.0.54
1 year ago
0.0.55
1 year ago
0.0.56
1 year ago
0.0.57
1 year ago
0.0.58
1 year ago
0.0.50
1 year ago
0.0.49
1 year ago
0.0.48
1 year ago
0.0.47
1 year ago
0.0.46
1 year ago
0.0.45
1 year ago
0.0.44
1 year ago
0.0.43
1 year ago
0.0.42
1 year ago
0.0.41
1 year ago
0.0.40
1 year ago
0.0.39
1 year ago
0.0.38
1 year ago
0.0.37
1 year ago
0.0.36
1 year ago
0.0.35
1 year ago
0.0.34
1 year ago
0.0.33
1 year ago
0.0.32
1 year ago
0.0.31
1 year ago
0.0.30
1 year ago
0.0.29
1 year ago
0.0.28
1 year ago
0.0.27
1 year ago
0.0.26
1 year ago
0.0.25
1 year ago
0.0.24
1 year ago
0.0.23
1 year ago
0.0.22
1 year ago
0.0.21
1 year ago
0.0.20
1 year ago
0.0.19
1 year ago
0.0.18
1 year ago
0.0.17
1 year ago
0.0.16
1 year ago
0.0.15
1 year ago
0.0.14
1 year ago
0.0.13
1 year ago
0.0.11
1 year ago
0.0.10
1 year ago
0.0.9
1 year ago
0.0.8
1 year ago
0.0.7
1 year ago
0.0.6
1 year ago
0.0.5
1 year ago
0.0.4
1 year ago
0.0.3
1 year ago
0.0.2
1 year ago
0.0.1
1 year ago