Skip to main content

Module: phisherman/src

Interfaces

Type Aliases

CheckReturnType

Ƭ CheckReturnType: PhishermanReturnType & { isScam: boolean }

Defined in

projects/utilities/packages/phisherman/src/lib/PhishermanTypes.ts:10

Functions

checkDomain

checkDomain(domain, apiKey?): Promise<{ classification: "unknown" | "malicious" | "suspicious" | "safe" ; isScam: boolean ; verifiedPhish: boolean }>

Parameters

NameTypeDefault valueDescription
domainstringundefined
apiKeystringstoredApiKey

Returns

Promise<{ classification: "unknown" | "malicious" | "suspicious" | "safe" ; isScam: boolean ; verifiedPhish: boolean }>

Defined in

projects/utilities/packages/phisherman/src/lib/Phisherman.ts:17


getDomainInfo

getDomainInfo(domain, apiKey?): Promise<PhishermanInfo>

Parameters

NameTypeDefault valueDescription
domainstringundefined
apiKeystringstoredApiKey

Returns

Promise<PhishermanInfo>

Defined in

projects/utilities/packages/phisherman/src/lib/Phisherman.ts:68


reportCaughtPhish

reportCaughtPhish(domain, apiKey?, guildId?): Promise<PhishermanReportType>

Parameters

NameTypeDefault valueDescription
domainstringundefined
apiKeystringstoredApiKey
guildIdstring | number''

Returns

Promise<PhishermanReportType>

Defined in

projects/utilities/packages/phisherman/src/lib/Phisherman.ts:91


reportDomain

reportDomain(domain, apiKey?): Promise<PhishermanReportType>

Parameters

NameTypeDefault valueDescription
domainstringundefined
apiKeystringstoredApiKey

Returns

Promise<PhishermanReportType>

Defined in

projects/utilities/packages/phisherman/src/lib/Phisherman.ts:43


setApiKey

setApiKey(key): Promise<void>

Parameters

NameTypeDescription
keystring

Returns

Promise<void>

Defined in

projects/utilities/packages/phisherman/src/lib/Phisherman.ts:114