All files / symbol-qr-library/src QRCodeSettings.ts

100% Statements 15/15
50% Branches 4/8
100% Functions 2/2
100% Lines 11/11

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69                                                1x             1x             1x             1x             1x           24x 24x 24x 24x       1x   1x  
/**
 * Copyright 2019 NEM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
type CorrectionLevel = 'high' | 'quartile' | 'medium' | 'low' | 'H' | 'Q' | 'M' | 'L' | undefined;
 
/**
 * Class `QRCodeSettings` describes rules for the generation
 * of NIP-7 compliant QR Codes.
 *
 * @since 0.2.0
 */
class QRCodeSettings {
 
    /**
     * The Error correction level.
     *
     * @var {ErrorCorrectLevel}
     */
    public static CORRECTION_LEVEL: CorrectionLevel = 'M';
 
    /**
     * The QR Code cell size in pixels.
     *
     * @var {number}
     */
    public static CELL_PIXEL_SIZE: number = 1;
 
    /**
     * The QR Code Margin in pixels.
     *
     * @var {number}
     */
    public static MARGIN_PIXEL: number = 2;
 
    /**
     * The QR Code Width in pixels.
     *
     * @var {number}
     */
    public static WIDTH: number = 250;
 
    /**
     * Constructor for QR code settings
     */
    constructor(
        public readonly EcorrectionLevel: CorrectionLevel = QRCodeSettings.CORRECTION_LEVEL,
        public readonly EwidthPixel: number = QRCodeSettings.WIDTH,
        public readonly EcellPixelSize: number = QRCodeSettings.CELL_PIXEL_SIZE,
        public readonly EmarginPixel: number = QRCodeSettings.MARGIN_PIXEL,
    ) {
 
    }
}
 
export {CorrectionLevel, QRCodeSettings};