UNPKG

2.01 kBTypeScriptView Raw
1import { EmptyObject } from '@terascope/utils';
2export declare type PackageInfo = {
3 dir: string;
4 relativeDir: string;
5 folderName: string;
6 private?: boolean;
7 name: string;
8 main: string;
9 srcMain?: string;
10 displayName: string;
11 version: string;
12 description: string;
13 license: string;
14 publishConfig?: {
15 access: 'public' | 'private';
16 registry: string;
17 };
18 terascope: PackageConfig;
19 resolutions: {
20 [pattern: string]: string;
21 };
22 dependencies: {
23 [pkg: string]: string;
24 };
25 devDependencies: {
26 [pkg: string]: string;
27 };
28 peerDependencies: {
29 [pkg: string]: string;
30 };
31};
32export declare enum Service {
33 Kafka = "kafka",
34 Elasticsearch = "elasticsearch"
35}
36export declare type PackageConfig = {
37 main?: boolean;
38 enableTypedoc?: boolean;
39 testSuite?: string;
40};
41export declare type RootPackageInfo = {
42 version: string;
43 dir: string;
44 relativeDir: string;
45 folderName: string;
46 name: string;
47 displayName: string;
48 bugs: {
49 url: string;
50 };
51 documentation: string;
52 homepage: string;
53 workspaces: string[] | {
54 packages: string[];
55 };
56 terascope: {
57 root: boolean;
58 type: 'monorepo';
59 target: string;
60 tests: {
61 suites: {
62 [suite: string]: Service[];
63 };
64 };
65 docker: {
66 registries: string[];
67 };
68 npm: {
69 registry: string;
70 };
71 };
72 resolutions: {
73 [pattern: string]: string;
74 };
75 dependencies?: {
76 [pkg: string]: string;
77 };
78 devDependencies?: {
79 [pkg: string]: string;
80 };
81 peerDependencies?: {
82 [pkg: string]: string;
83 };
84};
85export declare const AvailablePackageConfigKeys: readonly (keyof PackageConfig)[];
86export declare type TSCommands = 'docs';
87export declare type GlobalCMDOptions = EmptyObject;
88//# sourceMappingURL=interfaces.d.ts.map
\No newline at end of file