Skip to main content
Version: Current

foundation-filters

Home > @genesislcap/foundation-filters

foundation-filters package

Classes

ClassDescription
DefaultClientFilterRunnerDefault ClientFilterRunner DI implementation.
DefaultNodeEnvDefault NodeEnv DI implementation.
DefaultPercentageDefault Percentage DI implementation.
DefaultTimeWindowDefault TimeWindow DI implementation.
DefaultURLTargetingDefault URLTargeting DI implementation.
DefaultUserAgentDefault UserAgent DI implementation.
DefaultUserTargetingDefault UserTargeting DI implementation.

Functions

FunctionDescription
getFilterByName(name, container)Filer lookup by name.
nodeEnvFilter(envs)NodeEnv client filter function.
percentageFilter(percent, random)Percentage client filter function.
runner(filters, container)Client filter runner function.
timeWindowFilter(start, end)TimeWindow client filter function.
urlTargetingFilter(url, pattern, schemes, hosts, paths)URLTargeting client filter function.
userAgentFilter(browsers, devices, oss, ua)UserAgent client filter function.
userTargetingFilter(user, usernames, profiles, permissions)UserTargeting client filter function.

Interfaces

InterfaceDescription
ClientFilterClientFilter interface.
ClientFilterRunnerClientFilterRunner DI interface.
NodeEnvNodeEnv client filter DI interface.
PercentagePercentage client filter DI interface.
TimeWindowTimeWindow client filter DI interface.
URLTargetingURLTargeting client filter DI interface.
UserAgentUserAgent client filter DI interface.
UserTargetingUserTargeting client filter DI interface.

Variables

VariableDescription
ClientFilterName
loggerClient filter logger

Type Aliases

Type AliasDescription
ClientFilterName
ClientFilterSchemaClientFilterSchema type.
ClientFilterSchemasClientFilterSchemas type.
NodeEnvParamsNodeEnvParams
NodeEnvSchemaNodeEnvSchema type.
PercentageParamsPercentageParams
PercentageSchemaPercentageSchema type.
TimeWindowParamsTimeWindowParams
TimeWindowSchemaTimeWindowSchema type.
URLTargetingParamsURLTargetingParams
URLTargetingSchemaURLTargetingSchema type.
UserAgentParamsUserAgentParams
UserAgentSchemaUserAgentSchema type.
UserTargetingParamsUserTargetingParams
UserTargetingSchemaUserTargetingSchema type.