| // Licensed to the Software Freedom Conservancy (SFC) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The SFC licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| |
| export interface UnionOptions { |
| objectOnly?: boolean |
| } |
| |
| export interface UnionClass<T> { |
| build(data: unknown): Readonly<T> |
| fromWire(payload: unknown): Readonly<T> |
| } |
| |
| /** |
| * Registers a schema `union` — a value that may be any one of several variant |
| * record types, resolved by a discriminator field or by structural shape. |
| * @param name Schema type name, e.g. 'session.ProxyConfiguration'. |
| * @param selector The schema's `selector` node for this union. |
| * @param options |
| * @returns The registered union — `build(data)` resolves and constructs the matching |
| * variant outbound, `fromWire(payload)` resolves and parses it inbound. |
| */ |
| export function defineUnion<T>(name: string, selector: unknown, options?: UnionOptions): UnionClass<T> |
