///
/**
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [https://neo4j.com]
*
* Licensed 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.
*/
import { TransformStreamDefaultController, Transformer } from "./node/stream";
import { Counters, NotificationShape, ProfiledQueryPlan, RawQueryError, RawQueryValue } from "./types.codec";
export type HeaderEvent = {
$event: 'Header';
_body: {
fields?: string[];
};
};
export type RecordEvent = {
$event: 'Record';
_body: RawQueryValue[];
};
export type SummaryEvent = {
$event: 'Summary';
_body: {
notifications?: NotificationShape[];
counters?: Counters;
bookmarks?: string[];
profiledQueryPlan?: ProfiledQueryPlan;
queryPlan?: ProfiledQueryPlan;
};
};
export type ErrorEvent = {
$event: 'Error';
_body: RawQueryError[];
};
export type Event = HeaderEvent | RecordEvent | SummaryEvent | ErrorEvent;
export declare class QueryApiEventTransformer implements Transformer {
transform(chunk: string, controller: TransformStreamDefaultController): void;
}