datastar

Refer to https://github.com/starfederation/datastar/blob/develop/sdk/README.md

Types

Event

pub type Event {
  EventMergeFragment(MergeFragmentEventConfig)
  EventRemoveFragments(RemoveFragmentsConfig)
  EventMergeSignals(MergeSignalsConfig)
  EventRemoveSignals(RemoveSignalsConfig)
  EventExecuteScript(ExecuteScriptConfig)
}

Constructors

EventMergeFragment(MergeFragmentEventConfig)

EventRemoveFragments(RemoveFragmentsConfig)

```
EventMergeSignals(MergeSignalsConfig)
```
```
EventRemoveSignals(RemoveSignalsConfig)
```
```
EventExecuteScript(ExecuteScriptConfig)
```

EventOption

opaque </>

pub opaque type EventOption(phantom)

EventType

</>

pub type EventType {
  ExecuteScript
  MergeFragments
  MergeSignals
  RemoveFragments
  RemoveSignals
}

Constructors

```
ExecuteScript
```
```
MergeFragments
```
```
MergeSignals
```
```
RemoveFragments
```
```
RemoveSignals
```

ExecuteScriptConfig

</>

pub type ExecuteScriptConfig {
  ExecuteScriptConfig(
    script: String,
    options: List(EventOption(ExecuteScriptOptionType)),
  )
}

Constructors

ExecuteScriptConfig(
  script: String,
  options: List(EventOption(ExecuteScriptOptionType)),
)

ExecuteScriptOptionType

opaque </>

pub opaque type ExecuteScriptOptionType

MergeFragmentEventConfig

opaque </>

pub opaque type MergeFragmentEventConfig

MergeFragmentOptionType

opaque </>

pub opaque type MergeFragmentOptionType

MergeMode

</>

pub type MergeMode {
  Morph
  Inner
  Outer
  Prepend
  Append
  Before
  After
  UpsertAttributes
}

Constructors

```
Morph
```
```
Inner
```
```
Outer
```
```
Prepend
```
```
Append
```
```
Before
```
```
After
```
```
UpsertAttributes
```

MergeSignalsConfig

</>

pub type MergeSignalsConfig {
  MergeSignalsConfig(
    signals: String,
    options: List(EventOption(MergeSignalsOptionType)),
  )
}

Constructors

MergeSignalsConfig(
  signals: String,
  options: List(EventOption(MergeSignalsOptionType)),
)

MergeSignalsOptionType

opaque </>

pub opaque type MergeSignalsOptionType

RemoveFragmentOptionType

opaque </>

pub opaque type RemoveFragmentOptionType

RemoveFragmentsConfig

</>

pub type RemoveFragmentsConfig {
  RemoveFragmentsConfig(
    selector: String,
    options: List(EventOption(RemoveFragmentOptionType)),
  )
}

Constructors

RemoveFragmentsConfig(
  selector: String,
  options: List(EventOption(RemoveFragmentOptionType)),
)

RemoveSignalsConfig

</>

pub type RemoveSignalsConfig {
  RemoveSignalsConfig(
    signals: List(String),
    options: List(EventOption(RemoveSignalsOptionType)),
  )
}

Constructors

RemoveSignalsConfig(
  signals: List(String),
  options: List(EventOption(RemoveSignalsOptionType)),
)

RemoveSignalsOptionType

opaque </>

pub opaque type RemoveSignalsOptionType

Functions

attributes

</>

pub fn attributes(
  value: List(#(String, String)),
) -> EventOption(ExecuteScriptOptionType)

Only used by execute_script

auto_remove

</>

pub fn auto_remove(
  value: Bool,
) -> EventOption(ExecuteScriptOptionType)

Options Only used by execute_script

event_id

</>

pub fn event_id(value: String) -> EventOption(a)

event_to_string

</>

pub fn event_to_string(event: Event) -> String

events_to_string

</>

pub fn events_to_string(events events: List(Event)) -> String

execute_script

</>

pub fn execute_script(
  script: String,
  options: List(EventOption(ExecuteScriptOptionType)),
) -> Event

merge_fragments

</>

pub fn merge_fragments(
  fragments fragments: String,
  options options: List(EventOption(MergeFragmentOptionType)),
) -> Event

Event constructors

merge_mode

</>

pub fn merge_mode(
  mode: MergeMode,
) -> EventOption(MergeFragmentOptionType)

merge_signals

</>

pub fn merge_signals(
  signals: String,
  options: List(EventOption(MergeSignalsOptionType)),
) -> Event

only_if_missing

</>

pub fn only_if_missing(
  value: Bool,
) -> EventOption(MergeSignalsOptionType)

remove_fragments

</>

pub fn remove_fragments(
  selector: String,
  options: List(EventOption(RemoveFragmentOptionType)),
) -> Event

remove_signals

</>

pub fn remove_signals(
  signals: List(String),
  options: List(EventOption(RemoveSignalsOptionType)),
) -> Event

retry

</>

pub fn retry(value: Int) -> EventOption(a)

selector

</>

pub fn selector(
  value: String,
) -> EventOption(MergeFragmentOptionType)

settle_duration

</>

pub fn settle_duration(value: Int) -> EventOption(a)

view_transition

</>

pub fn view_transition(value: Bool) -> EventOption(a)