0.0.71 • Published 2 years ago

nestdoc v0.0.71

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Maintenance Maintaner Website shields.io made-with-Markdown made-for-VSCode GitHub license Profile views GitHub contributors GitHub issues

GitHub forks GitHub stars GitHub watchers GitHub followers

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

2 years ago

0.0.71

2 years ago

0.0.69

2 years ago

0.0.67

2 years ago

0.0.68

2 years ago

0.0.64

2 years ago

0.0.66

2 years ago

0.0.62

2 years ago

0.0.63

2 years ago

0.0.60

2 years ago

0.0.61

2 years ago

0.0.59

2 years ago

0.0.51

2 years ago

0.0.52

2 years ago

0.0.53

2 years ago

0.0.54

2 years ago

0.0.55

2 years ago

0.0.56

2 years ago

0.0.57

2 years ago

0.0.58

2 years ago

0.0.50

2 years ago

0.0.49

3 years ago

0.0.48

3 years ago

0.0.47

3 years ago

0.0.46

3 years ago

0.0.45

3 years ago

0.0.44

3 years ago

0.0.43

3 years ago

0.0.42

3 years ago

0.0.41

3 years ago

0.0.40

3 years ago

0.0.39

3 years ago

0.0.38

3 years ago

0.0.37

3 years ago

0.0.36

3 years ago

0.0.35

3 years ago

0.0.34

3 years ago

0.0.33

3 years ago

0.0.32

3 years ago

0.0.31

3 years ago

0.0.30

3 years ago

0.0.29

3 years ago

0.0.28

3 years ago

0.0.27

3 years ago

0.0.26

3 years ago

0.0.25

3 years ago

0.0.24

3 years ago

0.0.23

3 years ago

0.0.22

3 years ago

0.0.21

3 years ago

0.0.20

3 years ago

0.0.19

3 years ago

0.0.18

3 years ago

0.0.17

3 years ago

0.0.16

3 years ago

0.0.15

3 years ago

0.0.14

3 years ago

0.0.13

3 years ago

0.0.11

3 years ago

0.0.10

3 years ago

0.0.9

3 years ago

0.0.8

3 years ago

0.0.7

3 years ago

0.0.6

3 years ago

0.0.5

3 years ago

0.0.4

3 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago