Function isPropertyNames

packages/effect/src/Schema.ts:9411–9443

(keySchema: Constraint, annotations?: Annotations.Filter)

 * @since 4.0.0
 */
export function isPropertyNames(keySchema: Constraint, annotations?: Annotations.Filter) {
  const propertyNames = toEncoded(keySchema)
  const parser = SchemaParser._issue(propertyNames.ast)
  return makeFilter<object>(
    (input, ast, options) => {
      const keys = Reflect.ownKeys(input)
      const issues: Array<SchemaIssue.Issue> = []
      for (const key of keys) {
        const issue = parser(key, options)
        if (issue !== undefined) {
          issues.push(new SchemaIssue.Pointer([key], issue))
          if (options.errors === "first") break
        }
      }
      if (Arr.isArrayNonEmpty(issues)) {
        return new SchemaIssue.Composite(ast, issues, input, options)
      }
      return true
    },
    {
      expected: "an object with property names matching the schema",
      representation: {
        id: "effect/schema/isPropertyNames",
        payload: null,
        schemas: [propertyNames.ast]
      },
      toJsonSchema: ({ schemas }) => ({ propertyNames: schemas[0] }),
      toCode: ({ schemas }) => ({ runtime: `Schema.isPropertyNames(${schemas[0].runtime})` }),
      [InternalAnnotations.STRUCTURAL_ANNOTATION_KEY]: true,
      ...annotations
    }
  )
}

/**
 * Reviver for persisted `isPropertyNames` checks.