Skip to content

Commit

Permalink
📝 Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nuintun committed May 22, 2019
1 parent 5efa96d commit e9ef080
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,39 +48,39 @@ console.log(qrcode.toDataURL());

- Get qrcode module count.

- setVersion(version: number): void
- setVersion(version: number): Encoder

- Set qrcode version, if set `0` the version will be set automatically.

- getVersion(): number

- Get qrcode version.

- setErrorCorrectionLevel(errorCorrectionLevel: ErrorCorrectionLevel): void
- setErrorCorrectionLevel(errorCorrectionLevel: ErrorCorrectionLevel): Encoder

- Set qrcode error correction level.

- getErrorCorrectionLevel(): ErrorCorrectionLevel

- Get qrcode error correction level.

- setEncodingHint(hasEncodingHint: boolean): void
- setEncodingHint(hasEncodingHint: boolean): Encoder

- Set qrcode encoding hint, it will add ECI in qrcode.

- getEncodingHint(): boolean

- Get qrcode encoding hint.

- write(data: string | QRByte | QRKanji | QRNumeric | QRAlphanumeric): void
- write(data: string | QRByte | QRKanji | QRNumeric | QRAlphanumeric): Encoder

- Add qrcode data, if string will use `QRByte` by default.

- isDark(row: number, col: number): boolean

- Get byte with row and col.

- make(): void
- make(): Encoder

- Make qrcode matrix.

Expand Down Expand Up @@ -132,12 +132,12 @@ qrcode

###### Methods

- setOptions(options: Optins): void
- setOptions(options: Optins): Decoder

- Set decode options.
- canOverwriteImage: boolean
- inversionAttempts: 'dontInvert' | 'onlyInvert' | 'attemptBoth' | 'invertFirst'
- greyScaleWeights: { red: number, green: number, blue: number, useIntegerApproximation: boolean }
- canOverwriteImage?: boolean
- inversionAttempts?: 'dontInvert' | 'onlyInvert' | 'attemptBoth' | 'invertFirst'
- greyScaleWeights?: { red: number, green: number, blue: number, useIntegerApproximation?: boolean }

- scan(src: string): Promise\<DecoderResult>

Expand Down

0 comments on commit e9ef080

Please sign in to comment.