@microsoft/kiota-abstractions/dist/es/src/serialization/serializationWriter.d.ts

Core abstractions for kiota generated libraries in TypeScript and JavaScript

/**
 * -------------------------------------------------------------------------------------------
 * Copyright (c) Microsoft Corporation.  All Rights Reserved.  Licensed under the MIT License.
 * See License in the project root for license information.
 * -------------------------------------------------------------------------------------------
 */
import type { Guid } from "../utils/guidUtils.js";
import type { DateOnly } from "../dateOnly.js";
import type { Duration } from "../duration.js";
import type { TimeOnly } from "../timeOnly.js";
import type { Parsable } from "./parsable.js";
import type { ModelSerializerFunction } from "./serializationFunctionTypes.js";
/** Defines an interface for serialization of objects to a stream. */
export interface SerializationWriter {
    /**
     * Writes the specified byte array value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeByteArrayValue(key?: string, value?: ArrayBuffer | null): void;
    /**
     * Writes the specified string value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeStringValue(key?: string, value?: string | null): void;
    /**
     * Writes the specified boolean value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeBooleanValue(key?: string, value?: boolean | null): void;
    /**
     * Writes the specified number value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeNumberValue(key?: string, value?: number | null): void;
    /**
     * Writes the specified Guid value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeGuidValue(key?: string, value?: Guid | null): void;
    /**
     * Writes the specified Date value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeDateValue(key?: string, value?: Date | null): void;
    /**
     * Writes the specified Duration value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeDurationValue(key?: string, value?: Duration | null): void;
    /**
     * Writes the specified TimeOnly value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeTimeOnlyValue(key?: string, value?: TimeOnly | null): void;
    /**
     * Writes the specified DateOnly value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeDateOnlyValue(key?: string, value?: DateOnly | null): void;
    /**
     * Writes the specified collection of primitive values to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param values the value to write to the stream.
     */
    writeCollectionOfPrimitiveValues<T>(key?: string, values?: T[] | null): void;
    /**
     * Writes the specified collection of object values to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param values the value to write to the stream.
     */
    writeCollectionOfObjectValues<T extends Parsable>(key?: string, values?: T[] | null, serializerMethod?: ModelSerializerFunction<T>): void;
    /**
     * Writes the specified model object value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param value the value to write to the stream.
     */
    writeObjectValue<T extends Parsable>(key?: string, value?: T | null, serializerMethod?: ModelSerializerFunction<T>): void;
    /**
     * Writes the specified enum value to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param values the value to write to the stream.
     */
    writeEnumValue<T>(key?: string, ...values: (T | null | undefined)[]): void;
    /**
     * Writes the specified collection of enum values to the stream with an optional given key.
     * @param key the key to write the value with.
     * @param values the value to write to the stream.
     */
    writeCollectionOfEnumValues<T>(key?: string, values?: (T | null | undefined)[]): void;
    /**
     * Writes a null value for the specified key.
     * @param key the key to write the value with.
     */
    writeNullValue(key?: string): void;
    /**
     * Gets the value of the serialized content.
     * @returns the value of the serialized content.
     */
    getSerializedContent(): ArrayBuffer;
    /**
     * Writes the specified additional data values to the stream with an optional given key.
     * @param value the values to write to the stream.
     */
    writeAdditionalData(value: Record<string, unknown> | undefined): void;
    /**
     * Gets the callback called before the object gets serialized.
     * @returns the callback called before the object gets serialized.
     */
    onBeforeObjectSerialization: ((value: Parsable) => void) | undefined;
    /**
     * Gets the callback called after the object gets serialized.
     * @returns the callback called after the object gets serialized.
     */
    onAfterObjectSerialization: ((value: Parsable) => void) | undefined;
    /**
     * Gets the callback called right after the serialization process starts.
     * @returns the callback called right after the serialization process starts.
     */
    onStartObjectSerialization: ((value: Parsable, writer: SerializationWriter) => void) | undefined;
}
//# sourceMappingURL=serializationWriter.d.ts.map