@giraphql/plugin-dataloader/lib/types.d.ts

A GiraphQL plugin for attaching dataloader to object types

import DataLoader from 'dataloader';
import { GraphQLResolveInfo } from 'graphql';
import { FieldKind, FieldNullability, FieldOptionsFromKind, InputFieldMap, InputShapeFromFields, InterfaceParam, InterfaceRef, InterfaceTypeOptions, MaybePromise, ObjectParam, ObjectRef, ObjectTypeOptions, OutputShape, ParentShape, Resolver, SchemaTypes, ShapeFromTypeParam, TypeParam } from '@giraphql/core';
export declare type DataloaderKey = bigint | number | string;
export declare type LoadableFieldOptions<Types extends SchemaTypes, ParentShape, Type extends TypeParam<Types>, Nullable extends FieldNullability<Type>, Args extends InputFieldMap, ResolveReturnShape, Key, CacheKey, Kind extends FieldKind = FieldKind> = Omit<FieldOptionsFromKind<Types, ParentShape, Type, Nullable, Args, Kind, Key, ResolveReturnShape>, 'resolve'> & {
    load: (keys: Key[], context: Types['Context']) => Promise<(Error | LoaderShapeFromType<Types, Type, Nullable>)[]>;
    loaderOptions?: DataLoader.Options<Key, LoaderShapeFromType<Types, Type, Nullable>, CacheKey>;
    sort?: (value: LoaderShapeFromType<Types, Type, false>) => Key;
    resolve: Resolver<ParentShape, InputShapeFromFields<Args>, Types['Context'], Type extends unknown[] ? Key[] : Key, ResolveReturnShape>;
};
export declare type DataloaderObjectTypeOptions<Types extends SchemaTypes, Shape, Key extends bigint | number | string, Interfaces extends InterfaceParam<Types>[], NameOrRef extends ObjectParam<Types> | string, CacheKey> = ObjectTypeOptions<Types, NameOrRef extends ObjectParam<Types> ? NameOrRef : ObjectRef<Shape>, Shape, Interfaces> & {
    load: (keys: Key[], context: Types['Context']) => Promise<(Error | Shape)[]>;
    loaderOptions?: DataLoader.Options<Key, Shape, CacheKey>;
} & ({
    toKey: (value: Shape) => Key;
    cacheResolved?: boolean;
    sort?: boolean;
} | {
    toKey?: undefined;
    cacheResolved?: (value: Shape) => Key;
    sort?: (value: Shape) => Key;
});
export declare type LoadableInterfaceOptions<Types extends SchemaTypes, Shape, Key extends bigint | number | string, Interfaces extends InterfaceParam<Types>[], NameOrRef extends InterfaceParam<Types> | string, CacheKey> = InterfaceTypeOptions<Types, NameOrRef extends InterfaceParam<Types> ? NameOrRef : InterfaceRef<Shape>, Shape, Interfaces> & {
    load: (keys: Key[], context: Types['Context']) => Promise<(Error | Shape)[]>;
    loaderOptions?: DataLoader.Options<Key, Shape, CacheKey>;
} & ({
    toKey: (value: Shape) => Key;
    cacheResolved?: boolean;
    sort?: boolean;
} | {
    toKey?: undefined;
    cacheResolved?: (value: Shape) => Key;
    sort?: (value: Shape) => Key;
});
export declare type LoadableUnionOptions<Types extends SchemaTypes, Key extends bigint | number | string, Member extends ObjectParam<Types>, CacheKey, Shape> = GiraphQLSchemaTypes.UnionTypeOptions<Types, Member> & {
    load: (keys: Key[], context: Types['Context']) => Promise<(Error | Shape)[]>;
    loaderOptions?: DataLoader.Options<Key, Shape, CacheKey>;
} & ({
    toKey: (value: Shape) => Key;
    cacheResolved?: boolean;
    sort?: boolean;
} | {
    toKey?: undefined;
    cacheResolved?: (value: Shape) => Key;
    sort?: (value: Shape) => Key;
});
export declare type LoaderShapeFromType<Types extends SchemaTypes, Type extends TypeParam<Types>, Nullable extends FieldNullability<Type>> = Type extends [TypeParam<Types>] ? ShapeFromTypeParam<Types, Type[0], Nullable> : ShapeFromTypeParam<Types, Type, Nullable>;
export interface LoadableRef<K, V, C> {
    getDataloader: (context: C) => DataLoader<K, V>;
}
export declare type LoadableNodeOptions<Types extends SchemaTypes, Shape extends object, Key extends bigint | number | string, Interfaces extends InterfaceParam<Types>[], NameOrRef extends ObjectParam<Types> | string, CacheKey> = Omit<DataloaderObjectTypeOptions<Types, Shape, Key, Interfaces, NameOrRef, CacheKey>, 'isTypeOf'> & (NameOrRef extends new (...args: any[]) => any ? {
    isTypeOf?: (obj: ParentShape<Types, Interfaces[number]>, context: Types['Context'], info: GraphQLResolveInfo) => boolean;
} : {
    isTypeOf: (obj: ParentShape<Types, Interfaces[number]>, context: Types['Context'], info: GraphQLResolveInfo) => boolean;
}) & {
    id: Omit<FieldOptionsFromKind<Types, Shape, 'ID', false, {}, 'Object', Shape, MaybePromise<OutputShape<Types, 'ID'>>>, 'args' | 'nullable' | 'type'>;
};
//# sourceMappingURL=types.d.ts.map