Logo for jsDocs.io

maxmind

  • Version 4.3.22
  • Published
  • 22 kB
  • 2 dependencies
  • MIT license

Install

npm i maxmind
yarn add maxmind
pnpm add maxmind

Overview

IP lookup using Maxmind databases

Index

Variables

Functions

Interfaces

Variables

variable _default

const _default: {
    init: () => never;
    open: <T extends Response>(
        filepath: string,
        opts?: OpenOpts,
        cb?: Callback
    ) => Promise<Reader<T>>;
    openSync: () => never;
    validate: (ip: string) => boolean;
};

    Functions

    function init

    init: () => never;

      function open

      open: <T extends Response>(
          filepath: string,
          opts?: OpenOpts,
          cb?: Callback
      ) => Promise<Reader<T>>;

        function openSync

        openSync: () => never;

          function validate

          validate: (ip: string) => boolean;

            Interfaces

            interface OpenOpts

            interface OpenOpts {}

              property cache

              cache?: {
                  max: number;
              };

                property watchForUpdates

                watchForUpdates?: boolean;

                  property watchForUpdatesHook

                  watchForUpdatesHook?: Callback;

                    property watchForUpdatesNonPersistent

                    watchForUpdatesNonPersistent?: boolean;

                      Package Files (1)

                      Dependencies (2)

                      Dev Dependencies (13)

                      Peer Dependencies (0)

                      No peer dependencies.

                      Badge

                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/maxmind.

                      • Markdown
                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/maxmind)
                      • HTML
                        <a href="https://www.jsdocs.io/package/maxmind"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>