Function makeIsBetween

repos/effect/packages/effect/src/Schema.ts:7187–7234

(deriveOptions: {
  readonly order: Order.Order<T>
  readonly annotate?:
    | ((options: {
      readonly minimum: T
      readonly maximum: T
      readonly exclusiveMinimum?: boolean | undefined
      readonly exclusiveMaximum?: boolean | undefined
    }) => Annotations.Filter)
    | undefined
  readonly formatter?: Formatter<T> | undefined
})

 *
 * @category validation
 * @since 4.0.0
 */
export const isBase64UrlReviver: SchemaRepresentation.FilterReviver<null> = InternalSchema.makeFilterReviver(
  "effect/schema/isBase64Url",
  Null,
  ({ annotations }) => isBase64Url(annotations)
)

/**
 * Validates at runtime that a string starts with the specified literal prefix.
 *
 * **Details**
 *
 * RegExp metacharacters in the prefix are escaped in JSON Schema and arbitrary
 * metadata so that the generated patterns retain literal `startsWith` semantics.
 *
 * @category validation
 * @since 4.0.0
 */
export function isStartsWith(startsWith: string, annotations?: Annotations.Filter) {
  const formatted = JSON.stringify(startsWith)
  const regExp = new globalThis.RegExp(`^${RegExp_.escape(startsWith)}`)
  return makeFilter(
    (s: string) => s.startsWith(startsWith),
    {
      expected: `a string starting with ${formatted}`,
      representation: {
        id: "effect/schema/isStartsWith",
        payload: { startsWith }
      },
      toJsonSchema: () => ({ pattern: regExp.source }),
      toCode: () => ({ runtime: `Schema.isStartsWith(${format(startsWith)})` }),
      arbitrary: {
        constraint: {
          patterns: [regExp.source]
        }
      },
      ...annotations
    }
  )
}

/**
 * Reviver for persisted `isStartsWith` checks.
 *
 * **When to use**
 *
 * Use when reconstructing documents that may contain checks created by {@link isStartsWith}.
 *
 * @see {@link isStartsWith} for creating the corresponding check
 *