EventBuilder
Defined in: builder/event.ts:11
Extends
Section titled “Extends”BaseBuilder.Omit<InputBuilder,"toDefinition">
Properties
Section titled “Properties”children
Section titled “children”
readonlychildren:EventBuilder[]
Defined in: builder/event.ts:13
readonlyinput:InputBuilder
Defined in: builder/event.ts:14
readonlykey:string
Defined in: builder/event.ts:12
readonlyprn:string
Defined in: builder/index.ts:32
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addArray()
Section titled “addArray()”addArray(
key):ArrayInputBuilder
Defined in: builder/input.ts:22
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”addChildEvent()
Section titled “addChildEvent()”addChildEvent(
event):this
Defined in: builder/event.ts:23
Adds an event that handlers of this event are allowed to publish.
Circuits (loops) in event handlers are detected at both build and runtime. If a loop is detected, an ERROR-011 is generated: https://www.notion.so/pynhq/No-Circular-Event-Dependencies-4788d49bd5dd49c4a760f8e841e3680b?pvs=4
Parameters
Section titled “Parameters”EventBuilder
Returns
Section titled “Returns”this
addJson()
Section titled “addJson()”addJson(
key,parser):JsonInputBuilder
Defined in: builder/input.ts:30
Parameters
Section titled “Parameters”string
parser
Section titled “parser”ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | JsonParse<any>
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”addListener()
Section titled “addListener()”addListener(
key,handler):EventListenerBuilder
Defined in: builder/event.ts:42
Adds a listener that will be called in response to publications of this event.
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”addObject()
Section titled “addObject()”addObject(
key):ObjectInputBuilder
Defined in: builder/input.ts:23
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”addProperty()
Section titled “addProperty()”Call Signature
Section titled “Call Signature”addProperty(
key,type):DataTypeInputBuilder
Defined in: builder/input.ts:24
Parameters
Section titled “Parameters”string
PrimitiveDataType | TemporalDataType
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”addProperty(
key,type):SelectInputBuilder
Defined in: builder/input.ts:25
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”addProperty(
key,type):JsonInputBuilder
Defined in: builder/input.ts:26
Parameters
Section titled “Parameters”string
ZodType
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”addProperty(
key,type):JsonInputBuilder
Defined in: builder/input.ts:28
Parameters
Section titled “Parameters”string
PrimitiveDataType | TemporalDataType | SelectDataType | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”addSchedule()
Section titled “addSchedule()”addSchedule(
key,crontab):EventSchedulerBuilder
Defined in: builder/event.ts:36
Schedules this event with the provided crontab; which is in Unix “Vixie” format. This function should not be used for strict timing guarantees; it’s intended to run with “best effort” on the supplied schedule. Specifically:
- Precise timing is not guaranteed
- For frequent (e.g. every minute) schedules, some may be skipped
Parameters
Section titled “Parameters”string
crontab
Section titled “crontab”string
Returns
Section titled “Returns”- LIMIT-13 https://www.notion.so/pynhq/Event-Schedules-1ea223795b6080e3a7e7d6614daa6321?pvs=4
- https://www.man7.org/linux/man-pages/man5/crontab.5.html
setDescription()
Section titled “setDescription()”setDescription(
description):this
Defined in: builder/index.ts:33
Parameters
Section titled “Parameters”description
Section titled “description”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”toDefinition()
Section titled “toDefinition()”toDefinition():
EventDefinition
Defined in: builder/event.ts:47
Returns the definition structure of this event.