@strapi/types/dist/modules/documents/index.d.ts

Shared typescript types for Strapi internal use

import type { UID } from '../..';
import type * as Middleware from './middleware';
import type { ServiceInstance } from './service-instance';
import type { AnyDocument } from './result';
import type { ComponentExtension } from './component-extension';
export * as Middleware from './middleware';
export * as Params from './params';
export * from './plugin';
export * from './result';
export * from './service-instance';
export type ID = string;
type ServiceUtils = {
    transformData: (data: any, opts: any) => Promise<AnyDocument>;
};
export type Service = {
    <TContentTypeUID extends UID.ContentType>(uid: TContentTypeUID): ServiceInstance<TContentTypeUID> & ComponentExtension<TContentTypeUID>;
    utils: ServiceUtils;
    /** Add a middleware for all uid's and a specific action
     *  @example - Add a default locale
     *  strapi.documents.use((ctx, next) => {
     *    if (!params.locale) params.locale = 'en'
     *    return next()
     *  })
     */
    use: (cb: Middleware.Middleware) => Service;
};
//# sourceMappingURL=index.d.ts.map