Drop node 18 and 20. Add 24. #1708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

mm-kevcenteno wants to merge 11 commits into main from kevin/drop-old-node

.github/workflows/lint.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -17,7 +17,7 @@ jobs: @@
               persist-credentials: false
           - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
             with:
-              node-version: 20
+              node-version: 22
           - name: Check that package-lock.json is valid JSON
             run: jq empty package-lock.json
           - name: Install npm packages
@@ Expand Down @@

.github/workflows/test.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -12,7 +12,7 @@ jobs: @@
         runs-on: ubuntu-latest
         strategy:
           matrix:
-            version: [18, 20, 22]
+            version: [22, 24]
         steps:
           - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
             with:
@@ Expand All / @@ -32,9 +32,13 @@ jobs: @@
             working-directory: e2e/js
           - run: npx jest
             working-directory: e2e/js
+            env:
+              NODE_OPTIONS: --experimental-vm-modules
           - run: npm ci
             working-directory: e2e/ts
           - run: npm link '@maxmind/geoip2-node'
             working-directory: e2e/ts
           - run: npx jest
             working-directory: e2e/ts
+            env:
+              NODE_OPTIONS: --experimental-vm-modules

CHANGELOG.md

-Original file line number
+Diff line change
@@ -1,6 +1,12 @@
     CHANGELOG
     =========
+.0.0
+    ------------------
+    * **Breaking** Dropped support for Node.js 18 and 20. Node.js 22 or greater is now
+    * **Breaking** Dropped commonjs support. The package is now only available as an ES module.
 .3.4 (2025-11-25)
     ------------------
@@ Expand Down @@

CLAUDE.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -12,7 +12,7 @@ The library provides both web service clients and database readers that return s
  
    **Key Technologies:**

    - TypeScript with strict type checking

    - Node.js 18+ (targets active LTS versions)

    - Node.js 22+ (targets active LTS versions)

    - maxmind (node-maxmind) for MMDB database reading

    - Jest for testing

    - ESLint + Prettier for code quality

    @@ -318,9 +318,9 @@ npm run build
  
    Note: Precious is already set up and handles code formatting and linting. Use `precious tidy -g` to automatically fix issues, and `precious lint -g` to check for remaining problems.

    ### Version Requirements

    - **Node.js 18+** required (targets active LTS: 18, 20, 22)

    - **Node.js 22+** required (targets active LTS: 22, 24)

    - Uses Node.js built-in `fetch` (no external HTTP libraries)

    - TypeScript 5.x

    - TypeScript 6.x

    ## Cross-Language Consistency

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -49,9 +49,7 @@ more details.
  
    ### Country Service

    ```js

    const WebServiceClient = require('@maxmind/geoip2-node').WebServiceClient;

    // Typescript:

    // import { WebServiceClient } from '@maxmind/geoip2-node';

    import { WebServiceClient } from '@maxmind/geoip2-node';

    // To use the GeoLite web service instead of the GeoIP web service, set

    // the host to geolite.info, e.g.:

    @@ -70,9 +68,7 @@ client.country('142.1.1.1').then(response => {
  
    ### City Plus Service

    ```js

    const WebServiceClient = require('@maxmind/geoip2-node').WebServiceClient;

    // Typescript:

    // import { WebServiceClient } from '@maxmind/geoip2-node';

    import { WebServiceClient } from '@maxmind/geoip2-node';

    // To use the GeoLite web service instead of the GeoIP web service, set

    // the host to geolite.info, e.g.:

    @@ -88,9 +84,7 @@ client.city('142.1.1.1').then(response => {
  
    ### Insights Service

    ```js

    const WebServiceClient = require('@maxmind/geoip2-node').WebServiceClient;

    // Typescript:

    // import { WebServiceClient } from '@maxmind/geoip2-node';

    import { WebServiceClient } from '@maxmind/geoip2-node';

    // Note that the Insights web service is only supported by the GeoIP

    // web service, not the GeoLite web service.

    @@ -150,9 +144,7 @@ database reader. As such, you have access to the same
  
    and can be used like this:

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    const options = {

      // you can use options like `cache` or `watchForUpdates`

    @@ -172,12 +164,10 @@ database, you can use `Reader.openBuffer()`.  Use cases include:
  
    * You want to fetch the database from an external source.

    ```js

    const fs = require('fs');

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { readFileSync } from 'node:fs';

    import { Reader } from '@maxmind/geoip2-node';

    const dbBuffer = fs.readFileSync('/usr/local/city-database.mmdb');

    const dbBuffer = readFileSync('/usr/local/city-database.mmdb');

    const reader = Reader.openBuffer(dbBuffer);

    console.log(reader.city('1.1.1.1'));

    @@ -188,9 +178,7 @@ console.log(reader.city('1.1.1.1'));
  
    ### Anonymous IP Database Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoIP2-Anonymous-IP.mmdb').then(reader => {

      const response = reader.anonymousIP('85.25.43.84');

    @@ -208,9 +196,7 @@ Reader.open('/usr/local/share/GeoIP/GeoIP2-Anonymous-IP.mmdb').then(reader => {
  
    ### Anonymous Plus Database Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoIP-Anonymous-Plus.mmdb').then(reader => {

      const response = reader.anonymousPlus('85.25.43.84');

    @@ -231,9 +217,7 @@ Reader.open('/usr/local/share/GeoIP/GeoIP-Anonymous-Plus.mmdb').then(reader => {
  
    ### ASN Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoLite2-ASN.mmdb').then(reader => {

      const response = reader.asn('128.101.101.101');

    @@ -246,9 +230,7 @@ Reader.open('/usr/local/share/GeoIP/GeoLite2-ASN.mmdb').then(reader => {
  
    ### City Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoIP2-City.mmdb').then(reader => {

      const response = reader.city('128.101.101.101');

    @@ -262,9 +244,7 @@ Reader.open('/usr/local/share/GeoIP/GeoIP2-City.mmdb').then(reader => {
  
    ### Connection-Type Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoIP2-Connection-Type.mmdb').then(reader => {

      const response = reader.connectionType('128.101.101.101');

    @@ -277,9 +257,7 @@ Reader.open('/usr/local/share/GeoIP/GeoIP2-Connection-Type.mmdb').then(reader =>
  
    ### Country Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoIP2-Country.mmdb').then(reader => {

      const response = reader.country('128.101.101.101');

    @@ -291,9 +269,7 @@ Reader.open('/usr/local/share/GeoIP/GeoIP2-Country.mmdb').then(reader => {
  
    ### Domain Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoIP2-Domain.mmdb').then(reader => {

      const response = reader.domain('128.101.101.101');

    @@ -306,9 +282,7 @@ Reader.open('/usr/local/share/GeoIP/GeoIP2-Domain.mmdb').then(reader => {
  
    ### Enterprise Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoIP2-Enterprise.mmdb').then(reader => {

      const response = reader.enterprise('128.101.101.101');

    @@ -320,9 +294,7 @@ Reader.open('/usr/local/share/GeoIP/GeoIP2-Enterprise.mmdb').then(reader => {
  
    ### ISP Example

    ```js

    const Reader = require('@maxmind/geoip2-node').Reader;

    // Typescript:

    // import { Reader } from '@maxmind/geoip2-node';

    import { Reader } from '@maxmind/geoip2-node';

    Reader.open('/usr/local/share/GeoIP/GeoIP2-ISP.mmdb').then(reader => {

      const response = reader.isp('128.101.101.101');

    @@ -414,7 +386,7 @@ correction, please [contact MaxMind support for help](https://support.maxmind.co
  
    ## Requirements

    MaxMind has tested this API with Node.js versions 18, 20, and 22.  We aim to support

    MaxMind has tested this API with Node.js versions 22 and 24.  We aim to support

    active and maintained LTS versions of Node.js.

    ## Contributing

e2e/js/index.spec.js

-Original file line number
+Diff line change
@@ -1,6 +1,4 @@
-    /* eslint-disable @typescript-eslint/no-require-imports */
-    const WebServiceClient = require('@maxmind/geoip2-node').WebServiceClient;
-    const Reader = require('@maxmind/geoip2-node').Reader;
+    import { WebServiceClient, Reader } from '@maxmind/geoip2-node';
     describe('WebServiceClient', () => {
       it('exists', () => {
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Drop node 18 and 20. Add 24. #1708

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Drop node 18 and 20. Add 24. #1708

Are you sure you want to change the base?

Uh oh!

Drop node 18 and 20. Add 24. #1708

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!