Skip to content

apollo-code


apollo-code / router/src / RouterPolicy

Interface: RouterPolicy

Properties

name

readonly name: string

Methods

dispose()?

optional dispose(): Promise<void>

Returns

Promise<void>


init()?

optional init(config): Promise<void>

Parameters

config

Record<string, unknown>

Returns

Promise<void>


onError()

onError(error, ctx): Promise<RouterDecision | "give-up">

Parameters

error

ProviderError

ctx

RouterContext

Returns

Promise<RouterDecision | "give-up">


onSuccess()?

optional onSuccess(decision, ctx): void | Promise<void>

Parameters

decision

RouterDecision

ctx

RouterContext

Returns

void | Promise<void>


pick()

pick(ctx, hint?): Promise<RouterDecision>

Parameters

ctx

RouterContext

hint?

RouterHint

Returns

Promise<RouterDecision>