1export type Platform = 'browser' | 'node' | 'neutral'
2export type Format = 'iife' | 'cjs' | 'esm'
3export type Loader = 'base64' | 'binary' | 'copy' | 'css' | 'dataurl' | 'default' | 'empty' | 'file' | 'js' | 'json' | 'jsx' | 'local-css' | 'text' | 'ts' | 'tsx'
4export type LogLevel = 'verbose' | 'debug' | 'info' | 'warning' | 'error' | 'silent'
5export type Charset = 'ascii' | 'utf8'
6export type Drop = 'console' | 'debugger'
7export type AbsPaths = 'code' | 'log' | 'metafile'
8
9interface CommonOptions {
10  /** Documentation: https://esbuild.github.io/api/#sourcemap */
11  sourcemap?: boolean | 'linked' | 'inline' | 'external' | 'both'
12  /** Documentation: https://esbuild.github.io/api/#legal-comments */
13  legalComments?: 'none' | 'inline' | 'eof' | 'linked' | 'external'
14  /** Documentation: https://esbuild.github.io/api/#source-root */
15  sourceRoot?: string
16  /** Documentation: https://esbuild.github.io/api/#sources-content */
17  sourcesContent?: boolean
18
19  /** Documentation: https://esbuild.github.io/api/#format */
20  format?: Format
21  /** Documentation: https://esbuild.github.io/api/#global-name */
22  globalName?: string
23  /** Documentation: https://esbuild.github.io/api/#target */
24  target?: string | string[]
25  /** Documentation: https://esbuild.github.io/api/#supported */
26  supported?: Record<string, boolean>
27  /** Documentation: https://esbuild.github.io/api/#platform */
28  platform?: Platform
29
30  /** Documentation: https://esbuild.github.io/api/#mangle-props */
31  mangleProps?: RegExp
32  /** Documentation: https://esbuild.github.io/api/#mangle-props */
33  reserveProps?: RegExp
34  /** Documentation: https://esbuild.github.io/api/#mangle-props */
35  mangleQuoted?: boolean
36  /** Documentation: https://esbuild.github.io/api/#mangle-props */
37  mangleCache?: Record<string, string | false>
38  /** Documentation: https://esbuild.github.io/api/#drop */
39  drop?: Drop[]
40  /** Documentation: https://esbuild.github.io/api/#drop-labels */
41  dropLabels?: string[]
42  /** Documentation: https://esbuild.github.io/api/#minify */
43  minify?: boolean
44  /** Documentation: https://esbuild.github.io/api/#minify */
45  minifyWhitespace?: boolean
46  /** Documentation: https://esbuild.github.io/api/#minify */
47  minifyIdentifiers?: boolean
48  /** Documentation: https://esbuild.github.io/api/#minify */
49  minifySyntax?: boolean
50  /** Documentation: https://esbuild.github.io/api/#line-limit */
51  lineLimit?: number
52  /** Documentation: https://esbuild.github.io/api/#charset */
53  charset?: Charset
54  /** Documentation: https://esbuild.github.io/api/#tree-shaking */
55  treeShaking?: boolean
56  /** Documentation: https://esbuild.github.io/api/#ignore-annotations */
57  ignoreAnnotations?: boolean
58
59  /** Documentation: https://esbuild.github.io/api/#jsx */
60  jsx?: 'transform' | 'preserve' | 'automatic'
61  /** Documentation: https://esbuild.github.io/api/#jsx-factory */
62  jsxFactory?: string
63  /** Documentation: https://esbuild.github.io/api/#jsx-fragment */
64  jsxFragment?: string
65  /** Documentation: https://esbuild.github.io/api/#jsx-import-source */
66  jsxImportSource?: string
67  /** Documentation: https://esbuild.github.io/api/#jsx-development */
68  jsxDev?: boolean
69  /** Documentation: https://esbuild.github.io/api/#jsx-side-effects */
70  jsxSideEffects?: boolean
71
72  /** Documentation: https://esbuild.github.io/api/#define */
73  define?: { [key: string]: string }
74  /** Documentation: https://esbuild.github.io/api/#pure */
75  pure?: string[]
76  /** Documentation: https://esbuild.github.io/api/#keep-names */
77  keepNames?: boolean
78
79  /** Documentation: https://esbuild.github.io/api/#abs-paths */
80  absPaths?: AbsPaths[]
81  /** Documentation: https://esbuild.github.io/api/#color */
82  color?: boolean
83  /** Documentation: https://esbuild.github.io/api/#log-level */
84  logLevel?: LogLevel
85  /** Documentation: https://esbuild.github.io/api/#log-limit */
86  logLimit?: number
87  /** Documentation: https://esbuild.github.io/api/#log-override */
88  logOverride?: Record<string, LogLevel>
89
90  /** Documentation: https://esbuild.github.io/api/#tsconfig-raw */
91  tsconfigRaw?: string | TsconfigRaw
92}
93
94export interface TsconfigRaw {
95  compilerOptions?: {
96    alwaysStrict?: boolean
97    baseUrl?: string
98    experimentalDecorators?: boolean
99    importsNotUsedAsValues?: 'remove' | 'preserve' | 'error'
100    jsx?: 'preserve' | 'react-native' | 'react' | 'react-jsx' | 'react-jsxdev'
101    jsxFactory?: string
102    jsxFragmentFactory?: string
103    jsxImportSource?: string
104    paths?: Record<string, string[]>
105    preserveValueImports?: boolean
106    strict?: boolean
107    target?: string
108    useDefineForClassFields?: boolean
109    verbatimModuleSyntax?: boolean
110  }
111}
112
113export interface BuildOptions extends CommonOptions {
114  /** Documentation: https://esbuild.github.io/api/#bundle */
115  bundle?: boolean
116  /** Documentation: https://esbuild.github.io/api/#splitting */
117  splitting?: boolean
118  /** Documentation: https://esbuild.github.io/api/#preserve-symlinks */
119  preserveSymlinks?: boolean
120  /** Documentation: https://esbuild.github.io/api/#outfile */
121  outfile?: string
122  /** Documentation: https://esbuild.github.io/api/#metafile */
123  metafile?: boolean
124  /** Documentation: https://esbuild.github.io/api/#outdir */
125  outdir?: string
126  /** Documentation: https://esbuild.github.io/api/#outbase */
127  outbase?: string
128  /** Documentation: https://esbuild.github.io/api/#external */
129  external?: string[]
130  /** Documentation: https://esbuild.github.io/api/#packages */
131  packages?: 'bundle' | 'external'
132  /** Documentation: https://esbuild.github.io/api/#alias */
133  alias?: Record<string, string>
134  /** Documentation: https://esbuild.github.io/api/#loader */
135  loader?: { [ext: string]: Loader }
136  /** Documentation: https://esbuild.github.io/api/#resolve-extensions */
137  resolveExtensions?: string[]
138  /** Documentation: https://esbuild.github.io/api/#main-fields */
139  mainFields?: string[]
140  /** Documentation: https://esbuild.github.io/api/#conditions */
141  conditions?: string[]
142  /** Documentation: https://esbuild.github.io/api/#write */
143  write?: boolean
144  /** Documentation: https://esbuild.github.io/api/#allow-overwrite */
145  allowOverwrite?: boolean
146  /** Documentation: https://esbuild.github.io/api/#tsconfig */
147  tsconfig?: string
148  /** Documentation: https://esbuild.github.io/api/#out-extension */
149  outExtension?: { [ext: string]: string }
150  /** Documentation: https://esbuild.github.io/api/#public-path */
151  publicPath?: string
152  /** Documentation: https://esbuild.github.io/api/#entry-names */
153  entryNames?: string
154  /** Documentation: https://esbuild.github.io/api/#chunk-names */
155  chunkNames?: string
156  /** Documentation: https://esbuild.github.io/api/#asset-names */
157  assetNames?: string
158  /** Documentation: https://esbuild.github.io/api/#inject */
159  inject?: string[]
160  /** Documentation: https://esbuild.github.io/api/#banner */
161  banner?: { [type: string]: string }
162  /** Documentation: https://esbuild.github.io/api/#footer */
163  footer?: { [type: string]: string }
164  /** Documentation: https://esbuild.github.io/api/#entry-points */
165  entryPoints?: (string | { in: string, out: string })[] | Record<string, string>
166  /** Documentation: https://esbuild.github.io/api/#stdin */
167  stdin?: StdinOptions
168  /** Documentation: https://esbuild.github.io/plugins/ */
169  plugins?: Plugin[]
170  /** Documentation: https://esbuild.github.io/api/#working-directory */
171  absWorkingDir?: string
172  /** Documentation: https://esbuild.github.io/api/#node-paths */
173  nodePaths?: string[]; // The "NODE_PATH" variable from Node.js
174}
175
176export interface StdinOptions {
177  contents: string | Uint8Array
178  resolveDir?: string
179  sourcefile?: string
180  loader?: Loader
181}
182
183export interface Message {
184  id: string
185  pluginName: string
186  text: string
187  location: Location | null
188  notes: Note[]
189
190  /**
191   * Optional user-specified data that is passed through unmodified. You can
192   * use this to stash the original error, for example.
193   */
194  detail: any
195}
196
197export interface Note {
198  text: string
199  location: Location | null
200}
201
202export interface Location {
203  file: string
204  namespace: string
205  /** 1-based */
206  line: number
207  /** 0-based, in bytes */
208  column: number
209  /** in bytes */
210  length: number
211  lineText: string
212  suggestion: string
213}
214
215export interface OutputFile {
216  path: string
217  contents: Uint8Array
218  hash: string
219  /** "contents" as text (changes automatically with "contents") */
220  readonly text: string
221}
222
223export interface BuildResult<ProvidedOptions extends BuildOptions = BuildOptions> {
224  errors: Message[]
225  warnings: Message[]
226  /** Only when "write: false" */
227  outputFiles: OutputFile[] | (ProvidedOptions['write'] extends false ? never : undefined)
228  /** Only when "metafile: true" */
229  metafile: Metafile | (ProvidedOptions['metafile'] extends true ? never : undefined)
230  /** Only when "mangleCache" is present */
231  mangleCache: Record<string, string | false> | (ProvidedOptions['mangleCache'] extends Object ? never : undefined)
232}
233
234export interface BuildFailure extends Error {
235  errors: Message[]
236  warnings: Message[]
237}
238
239/** Documentation: https://esbuild.github.io/api/#serve-arguments */
240export interface ServeOptions {
241  port?: number
242  host?: string
243  servedir?: string
244  keyfile?: string
245  certfile?: string
246  fallback?: string
247  cors?: CORSOptions
248  onRequest?: (args: ServeOnRequestArgs) => void
249}
250
251/** Documentation: https://esbuild.github.io/api/#cors */
252export interface CORSOptions {
253  origin?: string | string[]
254}
255
256export interface ServeOnRequestArgs {
257  remoteAddress: string
258  method: string
259  path: string
260  status: number
261  /** The time to generate the response, not to send it */
262  timeInMS: number
263}
264
265/** Documentation: https://esbuild.github.io/api/#serve-return-values */
266export interface ServeResult {
267  port: number
268  hosts: string[]
269}
270
271export interface TransformOptions extends CommonOptions {
272  /** Documentation: https://esbuild.github.io/api/#sourcefile */
273  sourcefile?: string
274  /** Documentation: https://esbuild.github.io/api/#loader */
275  loader?: Loader
276  /** Documentation: https://esbuild.github.io/api/#banner */
277  banner?: string
278  /** Documentation: https://esbuild.github.io/api/#footer */
279  footer?: string
280}
281
282export interface TransformResult<ProvidedOptions extends TransformOptions = TransformOptions> {
283  code: string
284  map: string
285  warnings: Message[]
286  /** Only when "mangleCache" is present */
287  mangleCache: Record<string, string | false> | (ProvidedOptions['mangleCache'] extends Object ? never : undefined)
288  /** Only when "legalComments" is "external" */
289  legalComments: string | (ProvidedOptions['legalComments'] extends 'external' ? never : undefined)
290}
291
292export interface TransformFailure extends Error {
293  errors: Message[]
294  warnings: Message[]
295}
296
297export interface Plugin {
298  name: string
299  setup: (build: PluginBuild) => (void | Promise<void>)
300}
301
302export interface PluginBuild {
303  /** Documentation: https://esbuild.github.io/plugins/#build-options */
304  initialOptions: BuildOptions
305
306  /** Documentation: https://esbuild.github.io/plugins/#resolve */
307  resolve(path: string, options?: ResolveOptions): Promise<ResolveResult>
308
309  /** Documentation: https://esbuild.github.io/plugins/#on-start */
310  onStart(callback: () =>
311    (OnStartResult | null | void | Promise<OnStartResult | null | void>)): void
312
313  /** Documentation: https://esbuild.github.io/plugins/#on-end */
314  onEnd(callback: (result: BuildResult) =>
315    (OnEndResult | null | void | Promise<OnEndResult | null | void>)): void
316
317  /** Documentation: https://esbuild.github.io/plugins/#on-resolve */
318  onResolve(options: OnResolveOptions, callback: (args: OnResolveArgs) =>
319    (OnResolveResult | null | undefined | Promise<OnResolveResult | null | undefined>)): void
320
321  /** Documentation: https://esbuild.github.io/plugins/#on-load */
322  onLoad(options: OnLoadOptions, callback: (args: OnLoadArgs) =>
323    (OnLoadResult | null | undefined | Promise<OnLoadResult | null | undefined>)): void
324
325  /** Documentation: https://esbuild.github.io/plugins/#on-dispose */
326  onDispose(callback: () => void): void
327
328  // This is a full copy of the esbuild library in case you need it
329  esbuild: {
330    context: typeof context,
331    build: typeof build,
332    buildSync: typeof buildSync,
333    transform: typeof transform,
334    transformSync: typeof transformSync,
335    formatMessages: typeof formatMessages,
336    formatMessagesSync: typeof formatMessagesSync,
337    analyzeMetafile: typeof analyzeMetafile,
338    analyzeMetafileSync: typeof analyzeMetafileSync,
339    initialize: typeof initialize,
340    version: typeof version,
341  }
342}
343
344/** Documentation: https://esbuild.github.io/plugins/#resolve-options */
345export interface ResolveOptions {
346  pluginName?: string
347  importer?: string
348  namespace?: string
349  resolveDir?: string
350  kind?: ImportKind
351  pluginData?: any
352  with?: Record<string, string>
353}
354
355/** Documentation: https://esbuild.github.io/plugins/#resolve-results */
356export interface ResolveResult {
357  errors: Message[]
358  warnings: Message[]
359
360  path: string
361  external: boolean
362  sideEffects: boolean
363  namespace: string
364  suffix: string
365  pluginData: any
366}
367
368export interface OnStartResult {
369  errors?: PartialMessage[]
370  warnings?: PartialMessage[]
371}
372
373export interface OnEndResult {
374  errors?: PartialMessage[]
375  warnings?: PartialMessage[]
376}
377
378/** Documentation: https://esbuild.github.io/plugins/#on-resolve-options */
379export interface OnResolveOptions {
380  filter: RegExp
381  namespace?: string
382}
383
384/** Documentation: https://esbuild.github.io/plugins/#on-resolve-arguments */
385export interface OnResolveArgs {
386  path: string
387  importer: string
388  namespace: string
389  resolveDir: string
390  kind: ImportKind
391  pluginData: any
392  with: Record<string, string>
393}
394
395export type ImportKind =
396  | 'entry-point'
397
398  // JS
399  | 'import-statement'
400  | 'require-call'
401  | 'dynamic-import'
402  | 'require-resolve'
403
404  // CSS
405  | 'import-rule'
406  | 'composes-from'
407  | 'url-token'
408
409/** Documentation: https://esbuild.github.io/plugins/#on-resolve-results */
410export interface OnResolveResult {
411  pluginName?: string
412
413  errors?: PartialMessage[]
414  warnings?: PartialMessage[]
415
416  path?: string
417  external?: boolean
418  sideEffects?: boolean
419  namespace?: string
420  suffix?: string
421  pluginData?: any
422
423  watchFiles?: string[]
424  watchDirs?: string[]
425}
426
427/** Documentation: https://esbuild.github.io/plugins/#on-load-options */
428export interface OnLoadOptions {
429  filter: RegExp
430  namespace?: string
431}
432
433/** Documentation: https://esbuild.github.io/plugins/#on-load-arguments */
434export interface OnLoadArgs {
435  path: string
436  namespace: string
437  suffix: string
438  pluginData: any
439  with: Record<string, string>
440}
441
442/** Documentation: https://esbuild.github.io/plugins/#on-load-results */
443export interface OnLoadResult {
444  pluginName?: string
445
446  errors?: PartialMessage[]
447  warnings?: PartialMessage[]
448
449  contents?: string | Uint8Array
450  resolveDir?: string
451  loader?: Loader
452  pluginData?: any
453
454  watchFiles?: string[]
455  watchDirs?: string[]
456}
457
458export interface PartialMessage {
459  id?: string
460  pluginName?: string
461  text?: string
462  location?: Partial<Location> | null
463  notes?: PartialNote[]
464  detail?: any
465}
466
467export interface PartialNote {
468  text?: string
469  location?: Partial<Location> | null
470}
471
472/** Documentation: https://esbuild.github.io/api/#metafile */
473export interface Metafile {
474  inputs: {
475    [path: string]: {
476      bytes: number
477      imports: {
478        path: string
479        kind: ImportKind
480        external?: boolean
481        original?: string
482        with?: Record<string, string>
483      }[]
484      format?: 'cjs' | 'esm'
485      with?: Record<string, string>
486    }
487  }
488  outputs: {
489    [path: string]: {
490      bytes: number
491      inputs: {
492        [path: string]: {
493          bytesInOutput: number
494        }
495      }
496      imports: {
497        path: string
498        kind: ImportKind | 'file-loader'
499        external?: boolean
500      }[]
501      exports: string[]
502      entryPoint?: string
503      cssBundle?: string
504    }
505  }
506}
507
508export interface FormatMessagesOptions {
509  kind: 'error' | 'warning'
510  color?: boolean
511  terminalWidth?: number
512}
513
514export interface AnalyzeMetafileOptions {
515  color?: boolean
516  verbose?: boolean
517}
518
519/** Documentation: https://esbuild.github.io/api/#watch-arguments */
520export interface WatchOptions {
521  delay?: number // In milliseconds
522}
523
524export interface BuildContext<ProvidedOptions extends BuildOptions = BuildOptions> {
525  /** Documentation: https://esbuild.github.io/api/#rebuild */
526  rebuild(): Promise<BuildResult<ProvidedOptions>>
527
528  /** Documentation: https://esbuild.github.io/api/#watch */
529  watch(options?: WatchOptions): Promise<void>
530
531  /** Documentation: https://esbuild.github.io/api/#serve */
532  serve(options?: ServeOptions): Promise<ServeResult>
533
534  cancel(): Promise<void>
535  dispose(): Promise<void>
536}
537
538// This is a TypeScript type-level function which replaces any keys in "In"
539// that aren't in "Out" with "never". We use this to reject properties with
540// typos in object literals. See: https://stackoverflow.com/questions/49580725
541type SameShape<Out, In extends Out> = In & { [Key in Exclude<keyof In, keyof Out>]: never }
542
543/**
544 * This function invokes the "esbuild" command-line tool for you. It returns a
545 * promise that either resolves with a "BuildResult" object or rejects with a
546 * "BuildFailure" object.
547 *
548 * - Works in node: yes
549 * - Works in browser: yes
550 *
551 * Documentation: https://esbuild.github.io/api/#build
552 */
553export declare function build<T extends BuildOptions>(options: SameShape<BuildOptions, T>): Promise<BuildResult<T>>
554
555/**
556 * This is the advanced long-running form of "build" that supports additional
557 * features such as watch mode and a local development server.
558 *
559 * - Works in node: yes
560 * - Works in browser: no
561 *
562 * Documentation: https://esbuild.github.io/api/#build
563 */
564export declare function context<T extends BuildOptions>(options: SameShape<BuildOptions, T>): Promise<BuildContext<T>>
565
566/**
567 * This function transforms a single JavaScript file. It can be used to minify
568 * JavaScript, convert TypeScript/JSX to JavaScript, or convert newer JavaScript
569 * to older JavaScript. It returns a promise that is either resolved with a
570 * "TransformResult" object or rejected with a "TransformFailure" object.
571 *
572 * - Works in node: yes
573 * - Works in browser: yes
574 *
575 * Documentation: https://esbuild.github.io/api/#transform
576 */
577export declare function transform<T extends TransformOptions>(input: string | Uint8Array, options?: SameShape<TransformOptions, T>): Promise<TransformResult<T>>
578
579/**
580 * Converts log messages to formatted message strings suitable for printing in
581 * the terminal. This allows you to reuse the built-in behavior of esbuild's
582 * log message formatter. This is a batch-oriented API for efficiency.
583 *
584 * - Works in node: yes
585 * - Works in browser: yes
586 */
587export declare function formatMessages(messages: PartialMessage[], options: FormatMessagesOptions): Promise<string[]>
588
589/**
590 * Pretty-prints an analysis of the metafile JSON to a string. This is just for
591 * convenience to be able to match esbuild's pretty-printing exactly. If you want
592 * to customize it, you can just inspect the data in the metafile yourself.
593 *
594 * - Works in node: yes
595 * - Works in browser: yes
596 *
597 * Documentation: https://esbuild.github.io/api/#analyze
598 */
599export declare function analyzeMetafile(metafile: Metafile | string, options?: AnalyzeMetafileOptions): Promise<string>
600
601/**
602 * A synchronous version of "build".
603 *
604 * - Works in node: yes
605 * - Works in browser: no
606 *
607 * Documentation: https://esbuild.github.io/api/#build
608 */
609export declare function buildSync<T extends BuildOptions>(options: SameShape<BuildOptions, T>): BuildResult<T>
610
611/**
612 * A synchronous version of "transform".
613 *
614 * - Works in node: yes
615 * - Works in browser: no
616 *
617 * Documentation: https://esbuild.github.io/api/#transform
618 */
619export declare function transformSync<T extends TransformOptions>(input: string | Uint8Array, options?: SameShape<TransformOptions, T>): TransformResult<T>
620
621/**
622 * A synchronous version of "formatMessages".
623 *
624 * - Works in node: yes
625 * - Works in browser: no
626 */
627export declare function formatMessagesSync(messages: PartialMessage[], options: FormatMessagesOptions): string[]
628
629/**
630 * A synchronous version of "analyzeMetafile".
631 *
632 * - Works in node: yes
633 * - Works in browser: no
634 *
635 * Documentation: https://esbuild.github.io/api/#analyze
636 */
637export declare function analyzeMetafileSync(metafile: Metafile | string, options?: AnalyzeMetafileOptions): string
638
639/**
640 * This configures the browser-based version of esbuild. It is necessary to
641 * call this first and wait for the returned promise to be resolved before
642 * making other API calls when using esbuild in the browser.
643 *
644 * - Works in node: yes
645 * - Works in browser: yes ("options" is required)
646 *
647 * Documentation: https://esbuild.github.io/api/#browser
648 */
649export declare function initialize(options: InitializeOptions): Promise<void>
650
651export interface InitializeOptions {
652  /**
653   * The URL of the "esbuild.wasm" file. This must be provided when running
654   * esbuild in the browser.
655   */
656  wasmURL?: string | URL
657
658  /**
659   * The result of calling "new WebAssembly.Module(buffer)" where "buffer"
660   * is a typed array or ArrayBuffer containing the binary code of the
661   * "esbuild.wasm" file.
662   *
663   * You can use this as an alternative to "wasmURL" for environments where it's
664   * not possible to download the WebAssembly module.
665   */
666  wasmModule?: WebAssembly.Module
667
668  /**
669   * By default esbuild runs the WebAssembly-based browser API in a web worker
670   * to avoid blocking the UI thread. This can be disabled by setting "worker"
671   * to false.
672   */
673  worker?: boolean
674}
675
676export let version: string
677
678// Call this function to terminate esbuild's child process. The child process
679// is not terminated and re-created after each API call because it's more
680// efficient to keep it around when there are multiple API calls.
681//
682// In node this happens automatically before the parent node process exits. So
683// you only need to call this if you know you will not make any more esbuild
684// API calls and you want to clean up resources.
685//
686// Unlike node, Deno lacks the necessary APIs to clean up child processes
687// automatically. You must manually call stop() in Deno when you're done
688// using esbuild or Deno will continue running forever.
689//
690// Another reason you might want to call this is if you are using esbuild from
691// within a Deno test. Deno fails tests that create a child process without
692// killing it before the test ends, so you have to call this function (and
693// await the returned promise) in every Deno test that uses esbuild.
694export declare function stop(): Promise<void>
695
696// Note: These declarations exist to avoid type errors when you omit "dom" from
697// "lib" in your "tsconfig.json" file. TypeScript confusingly declares the
698// global "WebAssembly" type in "lib.dom.d.ts" even though it has nothing to do
699// with the browser DOM and is present in many non-browser JavaScript runtimes
700// (e.g. node and deno). Declaring it here allows esbuild's API to be used in
701// these scenarios.
702//
703// There's an open issue about getting this problem corrected (although these
704// declarations will need to remain even if this is fixed for backward
705// compatibility with older TypeScript versions):
706//
707//   https://github.com/microsoft/TypeScript-DOM-lib-generator/issues/826
708//
709declare global {
710  namespace WebAssembly {
711    interface Module {
712    }
713  }
714  interface URL {
715  }
716}

16 unmodified lines
17
18		const steps = contentEl.createEl("div", { cls: "sbl-welcome-steps" });
19
20		const step1 = steps.createDiv({ cls: "sbl-welcome-step" });
21		step1.createEl("strong", { text: "1. Open your vault from sublimated" });
21		step1.createEl("strong", { text: "1. Open a sublimated folder as a vault" });
22		step1.createEl("p", {
23			text: "In Finder, open your sublimated folder (under CloudStorage) as an Obsidian vault. The plugin detects the .sbl/ folder automatically.",
23			text: "In Finder, open any sublimated folder (or subfolder) under CloudStorage as an Obsidian vault. The plugin activates automatically on synced files.",
24		});
25
26		const step2 = steps.createDiv({ cls: "sbl-welcome-step" });
27		step2.createEl("strong", { text: "2. Status bar shows sync info" });
8 unmodified lines
36		});
37
38		const links = contentEl.createDiv({ cls: "sbl-welcome-links" });
39		links.createEl("a", {
40			text: "Learn more at sublimated.com",
41			href: "https://sublimated.com",
40			text: "Documentation",
41			href: "https://sublimated.com/docs/obsidian",
42		});
43		links.createEl("br");
44		links.createEl("a", {
45			text: "Documentation",
46			href: "https://sublimated.com/docs/obsidian",
45			text: "Source code",
46			href: "https://sublimated.com/sublimated/code/obsidian",
47		});
48
49		const footer = contentEl.createDiv({ cls: "sbl-welcome-footer" });
50		footer.createEl("button", {
9 unmodified lines