IPInfoManager
Defined in: packages/core/src/handlers/geoip.ts:50
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new IPInfoManager(
logger,options?):IPInfoManager
Defined in: packages/core/src/handlers/geoip.ts:60
Parameters
Section titled “Parameters”logger
Section titled “logger”options?
Section titled “options?”IPInfoManagerOptions = {}
Returns
Section titled “Returns”IPInfoManager
Accessors
Section titled “Accessors”entryCount
Section titled “entryCount”Get Signature
Section titled “Get Signature”get entryCount():
number
Defined in: packages/core/src/handlers/geoip.ts:72
Returns
Section titled “Returns”number
isInitialized
Section titled “isInitialized”Get Signature
Section titled “Get Signature”get isInitialized():
boolean
Defined in: packages/core/src/handlers/geoip.ts:66
Returns
Section titled “Returns”boolean
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”checkCountryAccess()
Section titled “checkCountryAccess()”checkCountryAccess(
ip,blockedCountries,whitelistCountries?):Promise<[boolean,string|null]>
Defined in: packages/core/src/handlers/geoip.ts:204
Parameters
Section titled “Parameters”string
blockedCountries
Section titled “blockedCountries”readonly string[]
whitelistCountries?
Section titled “whitelistCountries?”readonly string[] | null
Returns
Section titled “Returns”Promise<[boolean, string | null]>
close()
Section titled “close()”close():
void
Defined in: packages/core/src/handlers/geoip.ts:240
The reference close: release the reader.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”getCountry()
Section titled “getCountry()”getCountry(
ip):string|null
Defined in: packages/core/src/handlers/geoip.ts:168
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string | null
Implementation of
Section titled “Implementation of”getStatus()
Section titled “getStatus()”getStatus():
object
Defined in: packages/core/src/handlers/geoip.ts:77
Returns
Section titled “Returns”object
entries
Section titled “entries”entries:
number
lastRefreshed
Section titled “lastRefreshed”lastRefreshed:
Date|null
ready:
boolean
initialize()
Section titled “initialize()”initialize():
Promise<void>
Defined in: packages/core/src/handlers/geoip.ts:92
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”initializeAgent()
Section titled “initializeAgent()”initializeAgent(
agentHandler):Promise<void>
Defined in: packages/core/src/handlers/geoip.ts:164
Parameters
Section titled “Parameters”agentHandler
Section titled “agentHandler”Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”initializeRedis()
Section titled “initializeRedis()”initializeRedis(
redisHandler):Promise<void>
Defined in: packages/core/src/handlers/geoip.ts:159
Parameters
Section titled “Parameters”redisHandler
Section titled “redisHandler”Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”refresh()
Section titled “refresh()”refresh():
Promise<void>
Defined in: packages/core/src/handlers/geoip.ts:134
The reference refresh: re-download and swap the reader.
Returns
Section titled “Returns”Promise<void>