Skip to main content

lightyear

Home > @runlightyear/lightyear

lightyear package

Classes

ClassDescription
AppWebhookConnector
AuthConnectorDocs for AuthConnector
BaseConnectorThe Base for all connectors.
GraphQLConnector

GraphQL Connector

The base for making calls to GraphQL APIs

HttpProxyResponseError
ModelConnector
OAuthConnector

OAuth2 Connector

Creates the input to the 3 essential OAuth tasks:

1. Generates a url to request an access token 2. Converts the oauth callback parameters into the https call to request an access token 3. Provides the https params to refresh an access token

RestConnector

Rest Connector

The base for making calls to REST APIs

SmtpConnectorSmtp Connector
SyncConnector

Functions

FunctionDescription
confirmChange(props)
confirmChangeBatch(props)
defineAction(props)Define an Action
defineAuthorizer(props)
defineCollection(props)
defineCrmCollection(props)
defineCustomApp(props)(BETA) Define a Custom App
defineIntegration(props)
defineOAuth(props)
defineSyncAction(props)
defineSyncIntegration(props)
defineWebhook(props)Define a Webhook
deleteObject(props)
detectHardDeletes(props)
finishSync(syncId)
getCache(props)
getDeployList()
getModels(props)
isFunction(val)
isHttpProxyResponseError(error)
saveCache(props)
setSecret(name, value)Set a secret on the current action or webhook.
setSubscriptionExpiresAt(value)
setVariable(name, value)Set a variable on the current action or webhook.
sleep(delay)
upsertObject(props)
upsertObjectBatch(props)

Variables

VariableDescription
dayjsUtc
RERUN

This can be thrown inside a RunFunc to end execution tell the action to rerun.

The action will be rerun with the same props as the original run.

SKIPPEDThis can be thrown inside a RunFunc to end execution and mark the run as Skipped.