Add type hints

G4brym · Feb 28, 2024 · fb970a5 · fb970a5
1 parent 778efb1
commit fb970a5
Show file tree

Hide file tree

Showing 26 changed files with 284 additions and 1,194 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.prettierrc.js b/.prettierrc.js
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Gabriel Massadas
+Copyright (c) 2024 Gabriel Massadas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -47,19 +47,28 @@ export default {
   async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
     const qb = new D1QB(env.DB)
 
-    const fetched = await qb
-      .fetchOne({
+    type Employee = {
+      name: string
+      role: string
+      level: number
+    }
+
+    const employeeList = await qb
+      .fetchOne<Employee>({
         tableName: 'employees',
-        fields: 'count(*) as count',
+        fields: '*',
         where: {
           conditions: 'active = ?1',
           params: [true],
         },
       })
       .execute()
 
+    // You get IDE type hints on each employee data, like:
+    // employeeList.results[0].name
+
     return Response.json({
-      activeEmployees: fetched.results?.count || 0,
+      activeEmployees: employeeList.results?.length || 0,
     })
   },
 }

diff --git a/commitlint.config.js → commitlint.config.cjs b/commitlint.config.js → commitlint.config.cjs
diff --git a/config/fileTransformer.js → config/fileTransformer.cjs b/config/fileTransformer.js → config/fileTransformer.cjs
diff --git a/config/preparePublish.js → config/preparePublish.cjs b/config/preparePublish.js → config/preparePublish.cjs
diff --git a/jest.config.js → jest.config.cjs b/jest.config.js → jest.config.cjs
@@ -4,7 +4,7 @@ module.exports = {
   transform: {
     '^.+\\.(ts|tsx)$': 'ts-jest',
     '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
-      './config/fileTransformer.js',
+      './config/fileTransformer.cjs',
   },
   globals: {
     'ts-jest': {