Skip to content
Regor

Regor API

This section contains the function-level reference for Regor.

Use this page as an index, then open each API page for signature details and examples.

App and Components

Section titled “App and Components”
  1. createApp
  2. defineComponent
  3. toFragment
  4. toJsonTemplate
  5. RegorConfig

Reactivity

Section titled “Reactivity”
  1. ref
  2. sref
  3. isRef
  4. isDeepRef
  5. unref
  6. pause
  7. resume
  8. trigger
  9. entangle

Computed and Effects

Section titled “Computed and Effects”
  1. computed
  2. computeRef
  3. computeMany
  4. watchEffect
  5. collectRefs
  6. silence

Observation and Batch

Section titled “Observation and Batch”
  1. observe
  2. observeMany
  3. observerCount
  4. batch
  5. startBatch
  6. endBatch

Lifecycle and Scope

Section titled “Lifecycle and Scope”
  1. useScope
  2. onMounted
  3. onUnmounted
  4. contextRegistry

Cleanup and Unbind

Section titled “Cleanup and Unbind”
  1. addUnbinder
  2. getBindData
  3. removeNode
  4. unbind
  5. drainUnbind

Utilities

Section titled “Utilities”
  1. flatten
  2. markRaw
  3. isRaw
  4. persist
  5. html
  6. raw

Logging

Section titled “Logging”
  1. warningHandler

Recommendation

Section titled “Recommendation”

Start with:

  1. createApp
  2. ref
  3. sref
  4. computed
  5. watchEffect