commit cb6d9ea44de80105274302ac785d3345a0aa64e8 · treybastian.com/winterVibesJS

+14

README.md

···

       1
       1
       +
       # winterVibesJS

     

       2
       2
       +
       No build JS twitch wintery overlay.

     

       3
       3
       +
       

     

       4
       4
       +
       Run locally and tweak or add the Github page (COMING SOON) as a browser source.

     

       5
       5
       +
       

     

       6
       6
       +
       ## 0 Dependencies required!

     

       7
       7
       +
       This project has no required dependencies.

     

       8
       8
       +
       

     

       9
       9
       +
       The only dependency in package.json is vite for HMR purposes while developing.

     

       10
       10
       +
       

     

       11
       11
       +
       Everything uses JSDoc

     

       12
       12
       +
       

     

       13
       13
       +
       

     

       14
       14
       +
       # THIS IS NOT DONE YET AND IS A WIP

-4

config.ts

···

       1
       1
       -
       export const CANVAS_WIDTH = 320;

     

       2
       2
       -
       export const CANVAS_HEIGHT = 180;

     

       3
       3
       -
       export const FLOOR_RAISE_THRESHOLD = 200;

     

       4
       4
       -
       export const MAX_PARTICAL_COUNT = 500;

-27

floor.ts

···

       1
       1
       -
       import { CANVAS_HEIGHT, CANVAS_WIDTH, FLOOR_RAISE_THRESHOLD } from "./config";

     

       2
       2
       -
       import Snowflake from "./snowflake";

     

       3
       3
       -
       

     

       4
       4
       -
       export default class Floor {

     

       5
       5
       -
         y: number = CANVAS_HEIGHT;

     

       6
       6
       -
         accumulator = 0;

     

       7
       7
       -
       

     

       8
       8
       -
         checkColission(flake: Snowflake): Boolean {

     

       9
       9
       -
           if (flake.y >= this.y) {

     

       10
       10
       -
             this.accumulator++;

     

       11
       11
       -
       

     

       12
       12
       -
             if (this.accumulator % FLOOR_RAISE_THRESHOLD == 0) {

     

       13
       13
       -
               this.y -= 1;

     

       14
       14
       -
               console.log("floor raised");

     

       15
       15
       -
             }

     

       16
       16
       -
             return true;

     

       17
       17
       -
           }

     

       18
       18
       -
           return false;

     

       19
       19
       -
         }

     

       20
       20
       -
       

     

       21
       21
       -
         draw(ctx: CanvasRenderingContext2D) {

     

       22
       22
       -
           ctx.beginPath();

     

       23
       23
       -
           ctx.rect(0, this.y, CANVAS_WIDTH, CANVAS_HEIGHT - this.y);

     

       24
       24
       -
           ctx.fillStyle = "#fff";

     

       25
       25
       -
           ctx.fill();

     

       26
       26
       -
         }

     

       27
       27
       -
       }

+2 -2

index.html

···

       4
       4
        
           <meta charset="UTF-8" />

     

       5
       5
        
           <link rel="icon" type="image/svg+xml" href="/vite.svg" />

     

       6
       6
        
           <meta name="viewport" content="width=device-width, initial-scale=1.0" />

     

       7
       7
       -
           <title>Winter Vibes</title>

     

       7
       7
       +
           <title>Winter Vibes JS</title>

     

       8
       8
        
         </head>

     

       9
       9
        
         <body>

     

       10
       10
        
           <canvas id="main"></canvas>

     

       11
       11
       -
           <script type="module" src="/main.ts"></script>

     

       11
       11
       +
           <script type="module" src="/src/main.js"></script>

     

       12
       12
        
         </body>

     

       13
       13
        
       </html>

-46

main.ts

···

       1
       1
       -
       import "./style.css";

     

       2
       2
       -
       import Snowflake from "./snowflake";

     

       3
       3
       -
       import { CANVAS_HEIGHT, CANVAS_WIDTH, MAX_PARTICAL_COUNT } from "./config";

     

       4
       4
       -
       import Floor from "./floor";

     

       5
       5
       -
       

     

       6
       6
       -
       let canvas: HTMLCanvasElement;

     

       7
       7
       -
       let context: CanvasRenderingContext2D;

     

       8
       8
       -
       let lastSpawn: DOMHighResTimeStamp = 0;

     

       9
       9
       -
       let floor = new Floor();

     

       10
       10
       -
       let lastFrame: number = 0;

     

       11
       11
       -
       let fps = 0;

     

       12
       12
       -
       const snowFlakes: Snowflake[] = [];

     

       13
       13
       -
       

     

       14
       14
       -
       window.onload = init;

     

       15
       15
       -
       

     

       16
       16
       -
       function init() {

     

       17
       17
       -
         canvas = document.getElementById("main") as HTMLCanvasElement;

     

       18
       18
       -
         context = canvas.getContext("2d")!;

     

       19
       19
       -
         canvas.width = CANVAS_WIDTH;

     

       20
       20
       -
         canvas.height = CANVAS_HEIGHT;

     

       21
       21
       -
       

     

       22
       22
       -
         window.requestAnimationFrame(gameLoop);

     

       23
       23
       -
       }

     

       24
       24
       -
       

     

       25
       25
       -
       function gameLoop(delta: DOMHighResTimeStamp) {

     

       26
       26
       -
         fps = Math.round(1 / ((delta - lastFrame) / 1000));

     

       27
       27
       -
         context.clearRect(0, 0, CANVAS_WIDTH, CANVAS_HEIGHT);

     

       28
       28
       -
         if (delta - lastSpawn > 500 && snowFlakes.length < MAX_PARTICAL_COUNT) {

     

       29
       29
       -
           for (let i = 0; i < Math.floor(Math.random() * 2); i++) {

     

       30
       30
       -
             snowFlakes.push(new Snowflake());

     

       31
       31
       -
           }

     

       32
       32
       -
         }

     

       33
       33
       -
       

     

       34
       34
       -
         snowFlakes.forEach((flake) => {

     

       35
       35
       -
           flake.move();

     

       36
       36
       -
           if (floor.checkColission(flake)) {

     

       37
       37
       -
             flake.reset();

     

       38
       38
       -
           }

     

       39
       39
       -
           flake.draw(context);

     

       40
       40
       -
         });

     

       41
       41
       -
       

     

       42
       42
       -
         floor.draw(context);

     

       43
       43
       -
         context.fillText("FPS: " + fps, 10, 30);

     

       44
       44
       -
         lastFrame = delta;

     

       45
       45
       -
         window.requestAnimationFrame(gameLoop);

     

       46
       46
       -
       }

+2 -3

package.json

···

       1
       1
        
       {

     

       2
       2
        
         "name": "wintervibesjs",

     

       3
       3
       -
         "private": true,

     

       4
       4
       -
         "version": "0.0.0",

     

       3
       3
       +
         "private": false,

     

       4
       4
       +
         "version": "0.0.1",

     

       5
       5
        
         "type": "module",

     

       6
       6
        
         "scripts": {

     

       7
       7
        
           "dev": "vite",

     
···

       9
       9
        
           "preview": "vite preview"

     

       10
       10
        
         },

     

       11
       11
        
         "devDependencies": {

     

       12
       12
       -
           "typescript": "^5.6.3",

     

       13
       12
        
           "vite": "^5.4.10"

     

       14
       13
        
         }

     

       15
       14
        
       }

-42

snowflake.ts

···

       1
       1
       -
       import { CANVAS_WIDTH } from "./config";

     

       2
       2
       -
       

     

       3
       3
       -
       export default class Snowflake {

     

       4
       4
       -
         x: number;

     

       5
       5
       -
         y: number;

     

       6
       6
       -
         size: number;

     

       7
       7
       -
         speed: number;

     

       8
       8
       -
       

     

       9
       9
       -
         constructor() {

     

       10
       10
       -
           this.x = Math.floor(Math.random() * CANVAS_WIDTH);

     

       11
       11
       -
           this.y = -1;

     

       12
       12
       -
           this.speed = Math.random();

     

       13
       13
       -
           this.size = Math.floor(Math.random() * 4);

     

       14
       14
       -
         }

     

       15
       15
       -
       

     

       16
       16
       -
         reset() {

     

       17
       17
       -
           this.x = Math.floor(Math.random() * CANVAS_WIDTH);

     

       18
       18
       -
           this.y = -1;

     

       19
       19
       -
           this.speed = Math.random();

     

       20
       20
       -
           this.size = Math.floor(Math.random() * 4);

     

       21
       21
       -
         }

     

       22
       22
       -
       

     

       23
       23
       -
         draw(context: CanvasRenderingContext2D) {

     

       24
       24
       -
           context.beginPath();

     

       25
       25
       -
           context.rect(this.x, this.y, this.size, this.size);

     

       26
       26
       -
           context.fillStyle = "#fff";

     

       27
       27
       -
           context.fill();

     

       28
       28
       -
         }

     

       29
       29
       -
       

     

       30
       30
       -
         move() {

     

       31
       31
       -
           this.y += this.speed;

     

       32
       32
       -
           const sway = Math.random() < 0.5;

     

       33
       33
       -
           if (sway) {

     

       34
       34
       -
             const direction = Math.random() < 0.5;

     

       35
       35
       -
             if (direction) {

     

       36
       36
       -
               this.x += (this.speed * 5) / 10;

     

       37
       37
       -
             } else {

     

       38
       38
       -
               this.x -= (this.speed * 5) / 10;

     

       39
       39
       -
             }

     

       40
       40
       -
           }

     

       41
       41
       -
         }

     

       42
       42
       -
       }

+24

src/config.js

···

       1
       1
       +
       // canvas size - I chose these sizes for 16:9 aspect ratio and really pixely

     

       2
       2
       +
       export const CANVAS_WIDTH = 320;

     

       3
       3
       +
       export const CANVAS_HEIGHT = 180;

     

       4
       4
       +
       

     

       5
       5
       +
       // number of collisions required to shift the snowlevel up

     

       6
       6
       +
       export const FLOOR_RAISE_THRESHOLD = 100;

     

       7
       7
       +
       

     

       8
       8
       +
       // number of snowflakes to render

     

       9
       9
       +
       export const MAX_PARTICAL_COUNT = 200;

     

       10
       10
       +
       

     

       11
       11
       +
       // minimum size of snowflake

     

       12
       12
       +
       export const MIN_SIZE = 1;

     

       13
       13
       +
       

     

       14
       14
       +
       // maximum size of snowflake

     

       15
       15
       +
       export const MAX_SIZE = 4;

     

       16
       16
       +
       

     

       17
       17
       +
       // maximum speed of a falling snowflake

     

       18
       18
       +
       export const MAX_SPEED = 1;

     

       19
       19
       +
       

     

       20
       20
       +
       // minimum speed of a snowflake falling

     

       21
       21
       +
       export const MIN_SPEED = 0.5;

     

       22
       22
       +
       

     

       23
       23
       +
       // threshold for how fast snowflakes can go and have horizontal movement

     

       24
       24
       +
       export const SWAY_THRESHOLD = 0.8;

+69

src/main.js

···

       1
       1
       +
       import "./style.css";

     

       2
       2
       +
       import { CANVAS_HEIGHT, CANVAS_WIDTH, MAX_PARTICAL_COUNT } from "./config";

     

       3
       3
       +
       import { createSnowflake, drawSnowflake, moveSnowflake } from "./snowflake";

     

       4
       4
       +
       import {

     

       5
       5
       +
         checkCollision,

     

       6
       6
       +
         createSnowAccumulator,

     

       7
       7
       +
         drawSnowAccumulator,

     

       8
       8
       +
       } from "./snow_accumulator";

     

       9
       9
       +
       

     

       10
       10
       +
       /**

     

       11
       11
       +
        * @type {HTMLCanvasElement}

     

       12
       12
       +
        */

     

       13
       13
       +
       let canvas;

     

       14
       14
       +
       

     

       15
       15
       +
       /**

     

       16
       16
       +
        * @type {CanvasRenderingContext2D}

     

       17
       17
       +
        */

     

       18
       18
       +
       let ctx;

     

       19
       19
       +
       

     

       20
       20
       +
       /**

     

       21
       21
       +
        * @type{Array.<Snowflake>}

     

       22
       22
       +
        */

     

       23
       23
       +
       const snowFlakes = [];

     

       24
       24
       +
       

     

       25
       25
       +
       let lastSpawn = 0;

     

       26
       26
       +
       let floor = createSnowAccumulator(CANVAS_HEIGHT);

     

       27
       27
       +
       

     

       28
       28
       +
       let lastFrame = 0;

     

       29
       29
       +
       let fps = 0;

     

       30
       30
       +
       

     

       31
       31
       +
       window.onload = init;

     

       32
       32
       +
       

     

       33
       33
       +
       function init() {

     

       34
       34
       +
         // @ts-ignore -- I dunno how to get ts / jsdoc to be ok with this

     

       35
       35
       +
         canvas = document.getElementById("main");

     

       36
       36
       +
       

     

       37
       37
       +
         ctx = canvas.getContext("2d");

     

       38
       38
       +
         canvas.width = CANVAS_WIDTH;

     

       39
       39
       +
         canvas.height = CANVAS_HEIGHT;

     

       40
       40
       +
       

     

       41
       41
       +
         window.requestAnimationFrame(gameLoop);

     

       42
       42
       +
       }

     

       43
       43
       +
       

     

       44
       44
       +
       /**

     

       45
       45
       +
        * @param delta {DOMHighResTimeStamp}

     

       46
       46
       +
        */

     

       47
       47
       +
       function gameLoop(delta) {

     

       48
       48
       +
         fps = Math.round(1 / ((delta - lastFrame) / 1000));

     

       49
       49
       +
         ctx.clearRect(0, 0, CANVAS_WIDTH, CANVAS_HEIGHT);

     

       50
       50
       +
         if (delta - lastSpawn > 500 && snowFlakes.length < MAX_PARTICAL_COUNT) {

     

       51
       51
       +
           for (let i = 0; i < Math.floor(Math.random() * 2); i++) {

     

       52
       52
       +
             snowFlakes.push(createSnowflake());

     

       53
       53
       +
           }

     

       54
       54
       +
         }

     

       55
       55
       +
       

     

       56
       56
       +
         snowFlakes.forEach((flake, idx) => {

     

       57
       57
       +
           moveSnowflake(flake);

     

       58
       58
       +
           if (checkCollision(floor, flake)) {

     

       59
       59
       +
             snowFlakes[idx] = createSnowflake();

     

       60
       60
       +
           }

     

       61
       61
       +
           drawSnowflake(flake, ctx);

     

       62
       62
       +
         });

     

       63
       63
       +
       

     

       64
       64
       +
         drawSnowAccumulator(ctx, floor);

     

       65
       65
       +
         ctx.fillText("FPS: " + fps, 10, 30);

     

       66
       66
       +
         lastFrame = delta;

     

       67
       67
       +
       

     

       68
       68
       +
         window.requestAnimationFrame(gameLoop);

     

       69
       69
       +
       }

+40

src/snow_accumulator.js

···

       1
       1
       +
       import { CANVAS_HEIGHT, CANVAS_WIDTH, FLOOR_RAISE_THRESHOLD } from "./config";

     

       2
       2
       +
       

     

       3
       3
       +
       /**

     

       4
       4
       +
        * @param {number} y

     

       5
       5
       +
        * @returns {SnowAccumulator}

     

       6
       6
       +
        */

     

       7
       7
       +
       export function createSnowAccumulator(y) {

     

       8
       8
       +
         return {

     

       9
       9
       +
           accumulator: 0,

     

       10
       10
       +
           y,

     

       11
       11
       +
         };

     

       12
       12
       +
       }

     

       13
       13
       +
       

     

       14
       14
       +
       /**

     

       15
       15
       +
        * @param {SnowAccumulator} sa

     

       16
       16
       +
        * @param {Object} item

     

       17
       17
       +
        * @param {number} item.y

     

       18
       18
       +
        */

     

       19
       19
       +
       export function checkCollision(sa, { y }) {

     

       20
       20
       +
         if (y >= sa.y) {

     

       21
       21
       +
           sa.accumulator++;

     

       22
       22
       +
       

     

       23
       23
       +
           if (sa.accumulator % FLOOR_RAISE_THRESHOLD == 0) {

     

       24
       24
       +
             sa.y -= 1;

     

       25
       25
       +
           }

     

       26
       26
       +
           return true;

     

       27
       27
       +
         }

     

       28
       28
       +
         return false;

     

       29
       29
       +
       }

     

       30
       30
       +
       

     

       31
       31
       +
       /**

     

       32
       32
       +
        * @param {CanvasRenderingContext2D} ctx

     

       33
       33
       +
        * @param {SnowAccumulator} sa

     

       34
       34
       +
        */

     

       35
       35
       +
       export function drawSnowAccumulator(ctx, sa) {

     

       36
       36
       +
         ctx.beginPath();

     

       37
       37
       +
         ctx.rect(0, sa.y, CANVAS_WIDTH, CANVAS_HEIGHT - sa.y);

     

       38
       38
       +
         ctx.fillStyle = "#fff";

     

       39
       39
       +
         ctx.fill();

     

       40
       40
       +
       }

+50

src/snowflake.js

···

       1
       1
       +
       import {

     

       2
       2
       +
         CANVAS_WIDTH,

     

       3
       3
       +
         MAX_SIZE,

     

       4
       4
       +
         MAX_SPEED,

     

       5
       5
       +
         MIN_SIZE,

     

       6
       6
       +
         MIN_SPEED,

     

       7
       7
       +
         SWAY_THRESHOLD,

     

       8
       8
       +
       } from "./config";

     

       9
       9
       +
       

     

       10
       10
       +
       /**

     

       11
       11
       +
        * @returns {Snowflake}

     

       12
       12
       +
        */

     

       13
       13
       +
       export function createSnowflake() {

     

       14
       14
       +
         return {

     

       15
       15
       +
           x: Math.floor(Math.random() * CANVAS_WIDTH),

     

       16
       16
       +
           y: -1,

     

       17
       17
       +
           speed: Math.random() * (MIN_SPEED - MAX_SPEED) + MAX_SPEED,

     

       18
       18
       +
           size: Math.floor(Math.random() * (MIN_SIZE - MAX_SIZE) + MAX_SIZE),

     

       19
       19
       +
         };

     

       20
       20
       +
       }

     

       21
       21
       +
       

     

       22
       22
       +
       /**

     

       23
       23
       +
        * @param {Object} snowflake

     

       24
       24
       +
        * @param {number} snowflake.x

     

       25
       25
       +
        * @param {number} snowflake.y

     

       26
       26
       +
        * @param {number} snowflake.size

     

       27
       27
       +
        * @param {CanvasRenderingContext2D} ctx

     

       28
       28
       +
        */

     

       29
       29
       +
       export function drawSnowflake({ x, y, size }, ctx) {

     

       30
       30
       +
         ctx.beginPath();

     

       31
       31
       +
         ctx.rect(x, y, size, size);

     

       32
       32
       +
         ctx.fillStyle = "#fff";

     

       33
       33
       +
         ctx.fill();

     

       34
       34
       +
       }

     

       35
       35
       +
       

     

       36
       36
       +
       /**

     

       37
       37
       +
        * @param {Snowflake} snowflake

     

       38
       38
       +
        */

     

       39
       39
       +
       export function moveSnowflake(snowflake) {

     

       40
       40
       +
         snowflake.y += snowflake.speed;

     

       41
       41
       +
         const sway = Math.random() < 0.5 && snowflake.speed < SWAY_THRESHOLD;

     

       42
       42
       +
         if (sway) {

     

       43
       43
       +
           const direction = Math.random() < 0.5;

     

       44
       44
       +
           if (direction) {

     

       45
       45
       +
             snowflake.x += (snowflake.speed * 5) / 10;

     

       46
       46
       +
           } else {

     

       47
       47
       +
             snowflake.x -= (snowflake.speed * 5) / 10;

     

       48
       48
       +
           }

     

       49
       49
       +
         }

     

       50
       50
       +
       }

+14

src/types.d.ts

···

       1
       1
       +
       export {};

     

       2
       2
       +
       declare global {

     

       3
       3
       +
         type Snowflake = {

     

       4
       4
       +
           x: number;

     

       5
       5
       +
           y: number;

     

       6
       6
       +
           speed: number;

     

       7
       7
       +
           size: number;

     

       8
       8
       +
         };

     

       9
       9
       +
       

     

       10
       10
       +
         type SnowAccumulator = {

     

       11
       11
       +
           accumulator: number;

     

       12
       12
       +
           y: number;

     

       13
       13
       +
         };

     

       14
       14
       +
       }

style.css src/style.css

+13 -107

tsconfig.json

···

       1
       1
        
       {

     

       2
       2
        
         "compilerOptions": {

     

       3
       3
       -
           /* Visit https://aka.ms/tsconfig to read more about this file */

     

       4
       4
       -
       

     

       5
       5
       -
           /* Projects */

     

       6
       6
       -
           // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */

     

       7
       7
       -
           // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */

     

       8
       8
       -
           // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */

     

       9
       9
       -
           // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */

     

       10
       10
       -
           // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */

     

       11
       11
       -
           // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */

     

       12
       12
       -
       

     

       13
       13
       -
           /* Language and Environment */

     

       14
       14
       -
           "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */

     

       15
       15
       -
           // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */

     

       16
       16
       -
           // "jsx": "preserve",                                /* Specify what JSX code is generated. */

     

       17
       17
       -
           // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */

     

       18
       18
       -
           // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */

     

       19
       19
       -
           // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */

     

       20
       20
       -
           // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */

     

       21
       21
       -
           // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */

     

       22
       22
       -
           // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */

     

       23
       23
       -
           // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */

     

       24
       24
       -
           // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */

     

       25
       25
       -
           // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */

     

       26
       26
       -
       

     

       27
       27
       -
           /* Modules */

     

       28
       28
       -
           "module": "commonjs",                                /* Specify what module code is generated. */

     

       29
       29
       -
           // "rootDir": "./",                                  /* Specify the root folder within your source files. */

     

       30
       30
       -
           // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */

     

       31
       31
       -
           // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */

     

       32
       32
       -
           // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */

     

       33
       33
       -
           // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */

     

       34
       34
       -
           // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */

     

       35
       35
       -
           // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */

     

       36
       36
       -
           // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */

     

       37
       37
       -
           // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */

     

       38
       38
       -
           // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */

     

       39
       39
       -
           // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */

     

       40
       40
       -
           // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */

     

       41
       41
       -
           // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */

     

       42
       42
       -
           // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */

     

       43
       43
       -
           // "resolveJsonModule": true,                        /* Enable importing .json files. */

     

       44
       44
       -
           // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */

     

       45
       45
       -
           // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

     

       46
       46
       -
       

     

       47
       47
       -
           /* JavaScript Support */

     

       48
       48
       -
           // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */

     

       49
       49
       -
           // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */

     

       50
       50
       -
           // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

     

       51
       51
       -
       

     

       52
       52
       -
           /* Emit */

     

       53
       53
       -
           // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */

     

       54
       54
       -
           // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */

     

       55
       55
       -
           // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */

     

       56
       56
       -
           // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */

     

       57
       57
       -
           // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */

     

       58
       58
       -
           // "noEmit": true,                                   /* Disable emitting files from a compilation. */

     

       59
       59
       -
           // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */

     

       60
       60
       -
           // "outDir": "./",                                   /* Specify an output folder for all emitted files. */

     

       61
       61
       -
           // "removeComments": true,                           /* Disable emitting comments. */

     

       62
       62
       -
           // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */

     

       63
       63
       -
           // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */

     

       64
       64
       -
           // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */

     

       65
       65
       -
           // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */

     

       66
       66
       -
           // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */

     

       67
       67
       -
           // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */

     

       68
       68
       -
           // "newLine": "crlf",                                /* Set the newline character for emitting files. */

     

       69
       69
       -
           // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */

     

       70
       70
       -
           // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */

     

       71
       71
       -
           // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */

     

       72
       72
       -
           // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */

     

       73
       73
       -
           // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */

     

       74
       74
       -
       

     

       75
       75
       -
           /* Interop Constraints */

     

       76
       76
       -
           // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */

     

       77
       77
       -
           // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */

     

       78
       78
       -
           // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */

     

       79
       79
       -
           // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */

     

       80
       80
       -
           "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */

     

       81
       81
       -
           // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */

     

       82
       82
       -
           "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */

     

       83
       83
       -
       

     

       84
       84
       -
           /* Type Checking */

     

       85
       85
       -
           "strict": true,                                      /* Enable all strict type-checking options. */

     

       86
       86
       -
           // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */

     

       87
       87
       -
           // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */

     

       88
       88
       -
           // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */

     

       89
       89
       -
           // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */

     

       90
       90
       -
           // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */

     

       91
       91
       -
           // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */

     

       92
       92
       -
           // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */

     

       93
       93
       -
           // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */

     

       94
       94
       -
           // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */

     

       95
       95
       -
           // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */

     

       96
       96
       -
           // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */

     

       97
       97
       -
           // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */

     

       98
       98
       -
           // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */

     

       99
       99
       -
           // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */

     

       100
       100
       -
           // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */

     

       101
       101
       -
           // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */

     

       102
       102
       -
           // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */

     

       103
       103
       -
           // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */

     

       104
       104
       -
           // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */

     

       105
       105
       -
       

     

       106
       106
       -
           /* Completeness */

     

       107
       107
       -
           // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */

     

       108
       108
       -
           "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */

     

       109
       109
       -
         }

     

       3
       3
       +
           "allowJs": true,

     

       4
       4
       +
           "checkJs": true,

     

       5
       5
       +
           "noEmit": true,

     

       6
       6
       +
           "moduleResolution": "node",

     

       7
       7
       +
           "target": "ESNext",

     

       8
       8
       +
           "module": "ESNext",

     

       9
       9
       +
           "types": [

     

       10
       10
       +
             "./src/types"

     

       11
       11
       +
           ]

     

       12
       12
       +
         },

     

       13
       13
       +
         "include": [

     

       14
       14
       +
           "**/*.js"

     

       15
       15
       +
         ]

     

       110
       16
        
       }