外观
lib-obs 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793390383/FIN+5.3.1+lib-obs 中文整理基于 FIN 5.3.1
导读： 可观察数据流框架
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
概述（中译）
可观察数据流框架
API 正文（英文）
tags
| obsAddOnInit | Fire add event for all existing records in data set on initialization |
| obsAdds | Process when a new data item is added to the observed data set |
| obsCommits | Subscribe to record commits in Folio - see docs |
| obsCurVals | Subscribe to transient commits of curVal or curStatus - see docs |
| obsFilter | Filter string to define the record data set observed |
| obsHisWrites | Subscribe to history data updates- see docs |
| obsRecs | Base class for observables on database records |
| obsRemoves | Process when an existing data item is removed from the observed data set |
| obsSchedule | Subscribe to scheduled timer event - see docs |
| obsScheduleDaysOfMonth | Schedule events for given days of the month |
| obsScheduleDaysOfWeek | Schedule events for given days of the week |
| obsScheduleFreq | Schedule events with given frequency |
| obsScheduleSpan | Schedule events only during the configured span of time |
| obsScheduleTimes | Schedule events for given times of the day |
| obsUpdates | Process when an existing data item is updated in the observed data set |
| obsWatches | Subscribe to watch and unwatch events - see docs |
| observable | Observable subscription - see docs |
| observes | Observable subscription - see docs |
def
obsAddOnInit
Fire add event for all existing records in data set on initialization.
meta
| def | obsAddOnInit |
| is | marker |
| lib | lib:obs |
| tagOn | obsCommits |
supertypes
| marker | Marker labels a dict with typing information |
def
obsAdds
Process when a new data item is added to the observed data set.
meta
| def | obsAdds |
| is | marker |
| lib | lib:obs |
| tagOn | obsCommits |
supertypes
| marker | Marker labels a dict with typing information |
def
obsCommits
Subscribe to record commits in Folio - see docs
meta
| def | obsCommits |
| is | obsRecs |
| lib | lib:obs |
supertypes
| marker | Marker labels a dict with typing information |
| observable | Observable subscription - see docs |
| obsRecs | Base class for observables on database records |
tags
| obsAddOnInit | Fire add event for all existing records in data set on initialization |
| obsAdds | Process when a new data item is added to the observed data set |
| obsFilter | Filter string to define the record data set observed |
| obsRemoves | Process when an existing data item is removed from the observed data set |
| obsUpdates | Process when an existing data item is updated in the observed data set |
def
obsCurVals
Subscribe to transient commits of curVal or curStatus - see docs
meta
| def | obsCurVals |
| is | obsRecs |
| lib | lib:obs |
supertypes
| marker | Marker labels a dict with typing information |
| observable | Observable subscription - see docs |
| obsRecs | Base class for observables on database records |
tags
| obsFilter | Filter string to define the record data set observed |
def
obsFilter
Filter string to define the record data set observed. If omitted then all records in the database are observed. Note that obsFilter may not use the -> pathing operator.
meta
| def | obsFilter |
| is | filterStr |
| lib | lib:obs |
| tagOn | obsEvents, obsRecs |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
| filterStr | Haystack filter string |
subtypes
| obsRuleFilter | Filter string for rule records to observe |
| obsTargetFilter | Filter string for target records to observe |
def
obsHisWrites
Subscribe to history data updates- see docs
meta
| def | obsHisWrites |
| is | obsRecs |
| lib | lib:obs |
supertypes
| marker | Marker labels a dict with typing information |
| observable | Observable subscription - see docs |
| obsRecs | Base class for observables on database records |
tags
| obsFilter | Filter string to define the record data set observed |
def
obsRecs
Base class for observables on database records
meta
| def | obsRecs |
| is | observable |
| lib | lib:obs |
supertypes
| marker | Marker labels a dict with typing information |
| observable | Observable subscription - see docs |
subtypes
| obsArcs | Subscribe to arc document changes - see docs |
| obsCommits | Subscribe to record commits in Folio - see docs |
| obsCurVals | Subscribe to transient commits of curVal or curStatus - see docs |
| obsHisWrites | Subscribe to history data updates- see docs |
| obsPointWrites | Subscribe to writable point priority array updates - see docs |
| obsWatches | Subscribe to watch and unwatch events - see docs |
tags
| obsFilter | Filter string to define the record data set observed |
def
obsRemoves
Process when an existing data item is removed from the observed data set.
meta
| def | obsRemoves |
| is | marker |
| lib | lib:obs |
| tagOn | obsCommits |
supertypes
| marker | Marker labels a dict with typing information |
def
obsSchedule
Subscribe to scheduled timer event - see docs
meta
| def | obsSchedule |
| is | observable |
| lib | lib:obs |
supertypes
| marker | Marker labels a dict with typing information |
| observable | Observable subscription - see docs |
tags
| obsScheduleDaysOfMonth | Schedule events for given days of the month |
| obsScheduleDaysOfWeek | Schedule events for given days of the week |
| obsScheduleFreq | Schedule events with given frequency |
| obsScheduleSpan | Schedule events only during the configured span of time |
| obsScheduleTimes | Schedule events for given times of the day |
def
obsScheduleDaysOfMonth
Schedule events for given days of the month. Encode as a comma separated list for day of the month such as "1,15". Negative values may be used to represent days for end of the month. For example "-1" represents the last day of the month, "-2" the second to last, etc.
meta
| def | obsScheduleDaysOfMonth |
| is | str |
| lib | lib:obs |
| placeholder | e.g. 1, 15 |
| tagOn | obsSchedule |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
obsScheduleDaysOfWeek
Schedule events for given days of the week. Encode as a comma separated list of the three letter enums: sun, mon, tue, wed, thu, fri, or sat.
meta
| def | obsScheduleDaysOfWeek |
| is | str |
| lib | lib:obs |
| tagOn | obsSchedule |
| uiInput | uiMisc::WeekdayInput |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
obsScheduleFreq
Schedule events with given frequency
meta
| def | obsScheduleFreq |
| is | duration |
| lib | lib:obs |
| minVal | 1sec |
| tagOn | obsSchedule |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| number | Integer or floating point numbers annotated with an optional unit |
| duration | Number with a unit of time |
def
obsScheduleSpan
Schedule events only during the configured span of time.
meta
| def | obsScheduleSpan |
| is | span |
| lib | lib:obs |
| tagOn | obsSchedule |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| xstr | Extended string - type name and string value encoding |
| span | Time span as modeled encoded as XStr |
def
obsScheduleTimes
Schedule events for given times of the day
meta
| def | obsScheduleTimes |
| is | list |
| lib | lib:obs |
| of | time |
| tagOn | obsSchedule |
| uiInput | ui::CompactListInput |
supertypes
| val | Data value type |
| list | Ordered list of zero or more values |
def
obsUpdates
Process when an existing data item is updated in the observed data set.
meta
| def | obsUpdates |
| is | marker |
| lib | lib:obs |
| tagOn | obsCommits |
supertypes
| marker | Marker labels a dict with typing information |
def
obsWatches
Subscribe to watch and unwatch events - see docs
meta
| def | obsWatches |
| is | obsRecs |
| lib | lib:obs |
supertypes
| marker | Marker labels a dict with typing information |
| observable | Observable subscription - see docs |
| obsRecs | Base class for observables on database records |
tags
| obsFilter | Filter string to define the record data set observed |
def
observable
Observable subscription - see docs
meta
| def | observable |
| is | marker |
| lib | lib:obs |
supertypes
| marker | Marker labels a dict with typing information |
subtypes
| obsEvents | Subscribe to event creation - see docs |
| obsMqtt | Subscribe to MQTT connector published messages |
| obsRecs | Base class for observables on database records |
| obsArcs | Subscribe to arc document changes - see docs |
| obsCommits | Subscribe to record commits in Folio - see docs |
| obsCurVals | Subscribe to transient commits of curVal or curStatus - see docs |
| obsHisWrites | Subscribe to history data updates- see docs |
| obsPointWrites | Subscribe to writable point priority array updates - see docs |
| obsWatches | Subscribe to watch and unwatch events - see docs |
| obsSchedule | Subscribe to scheduled timer event - see docs |
| obsSparks | Subscribe to rule engine sparks - see docs |
def
observes
Observable subscription - see docs
meta
| def | observes |
| is | choice |
| lib | lib:obs |
| of | observable |
| tagOn | task |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |