Flow.md

@fluxninja/aperture-js / Flow

Interface: Flow

Table of contents

Methods

• checkResponse
• deleteGlobalCache
• deleteResultCache
• end
• error
• globalCache
• httpResponseCode
• resultCache
• retryAfter
• setGlobalCache
• setResultCache
• setStatus
• shouldRun
• span

Methods

checkResponse

▸ checkResponse(): null | CheckResponse__Output

Returns

null | CheckResponse__Output

---

deleteGlobalCache

▸ deleteGlobalCache(key, grpcOptions?): Promise<KeyDeleteResponse>

Parameters

Name	Type
key	string
grpcOptions?	CallOptions

Returns

Promise<KeyDeleteResponse>

---

deleteResultCache

▸ deleteResultCache(grpcOptions?): Promise<undefined | KeyDeleteResponse>

Parameters

Name	Type
grpcOptions?	CallOptions

Returns

Promise<undefined | KeyDeleteResponse>

---

end

▸ end(grpcOptions?): Promise<FlowEndResponse>

Parameters

Name	Type
grpcOptions?	CallOptions

Returns

Promise<FlowEndResponse>

---

error

▸ error(): null | Error

Returns

null | Error

---

globalCache

▸ globalCache(key): KeyLookupResponse

Parameters

Name	Type
key	string

Returns

KeyLookupResponse

---

httpResponseCode

▸ httpResponseCode(): undefined | Number

Returns

undefined | Number

---

resultCache

▸ resultCache(): KeyLookupResponse

Returns

KeyLookupResponse

---

retryAfter

▸ retryAfter(): Object

Returns

Object

Name	Type
nanos	undefined | number
seconds	undefined | string

---

setGlobalCache

▸ setGlobalCache(key, cacheEntry, grpcOptions?): Promise<KeyUpsertResponse>

Parameters

Name	Type
key	string
cacheEntry	CacheEntry
grpcOptions?	CallOptions

Returns

Promise<KeyUpsertResponse>

---

setResultCache

▸ setResultCache(cacheEntry, grpcOptions?): Promise<KeyUpsertResponse>

Parameters

Name	Type
cacheEntry	CacheEntry
grpcOptions?	CallOptions

Returns

Promise<KeyUpsertResponse>

---

setStatus

▸ setStatus(status): void

Parameters

Name	Type
status	FlowStatus

Returns

void

---

shouldRun

▸ shouldRun(): boolean

Returns

boolean

---

span

▸ span(): Span

Returns

Span