Function createSampling

src/effector/sample.ts:89–243

(
  method: string,
  clock: DataCarrier | DataCarrier[] | void,
  source: DataCarrier | Array<Store<any>> | Record<string, Store<any>> | void,
  filter: any,
  target: DataCarrier | DataCarrier[] | void,
  fn: any,
  name: string | undefined,
  metadata: object | void,
  batch: boolean,
  targetMayBeStore: boolean,
  filterRequired: boolean,
  sid?: string | undefined,
)

}

export const createSampling = (
  method: string,
  clock: DataCarrier | DataCarrier[] | void,
  source: DataCarrier | Array<Store<any>> | Record<string, Store<any>> | void,
  filter: any,
  target: DataCarrier | DataCarrier[] | void,
  fn: any,
  name: string | undefined,
  metadata: object | void,
  batch: boolean,
  targetMayBeStore: boolean,
  filterRequired: boolean,
  sid?: string | undefined,
) => {
  const errorTitle = generateErrorTitle(method, metadata)
  const isUpward = !!target
  assert(
    !isVoid(source) || !isVoid(clock),
    fieldErrorMessage(errorTitle, 'either source or clock'),
  )
  let sourceIsClock = false
  if (isVoid(source)) {
    sourceIsClock = true
  } else if (!is.unit(source)) {
    source = combine(source)
  }
  if (isVoid(clock)) {
    /** still undefined! */
    clock = source
  } else {
    assertNodeSet(clock, errorTitle, 'clock')
    if (Array.isArray(clock)) {
      clock = createLinkNode(clock as CommonUnit[], [], [], method)
    }
  }
  if (sourceIsClock) {
    source = clock
  }
  if (!metadata && !name) {
    /**
     * When there is no metadata and name, assign source name as a fallback.
     * This is very misleading behavior (sample unit is not a source unit)
     * introduced a long time ago, so we keep it only for backward compatibility
     * for cases which were covered at the time.
     *
     * Therefore, this name will not be used as a fallback for newer (23.4.0) cases
     * (a.k.a. sample support for patronum debug traces)
     * and metadata will not be created
     */
    name = (source as any).shortName
  } else if (metadata && name) {
    /** name field from sample config (from user) has highest priority */
    ;(metadata as any).name = name
  } else if (!metadata && name) {
    /**
     * metadata comes from plugin, so when name is present and metadata is missing,
     * we need to create fresh metadata with name
     */