From 999d8312e154debe8c02fa6caeb9a4f0b40b1e20 Mon Sep 17 00:00:00 2001 From: Christian Bromann Date: Wed, 3 Apr 2024 14:08:26 -0700 Subject: [PATCH] docs(compiler): remove docs on loading the Stencil compiler in a Web Worker or browser (#1391) * docs(compiler): don't recommend embedding compiler as browser script * docs(compiler): don't recommend embedding compiler within service worker either * revert esm import doc --- docs/core/compiler-api.md | 9 --------- versioned_docs/version-v4.0/core/compiler-api.md | 9 --------- versioned_docs/version-v4.1/core/compiler-api.md | 9 --------- versioned_docs/version-v4.10/core/compiler-api.md | 9 --------- versioned_docs/version-v4.11/core/compiler-api.md | 9 --------- versioned_docs/version-v4.12/core/compiler-api.md | 9 --------- versioned_docs/version-v4.13.0/core/compiler-api.md | 9 --------- versioned_docs/version-v4.14/core/compiler-api.md | 9 --------- versioned_docs/version-v4.2/core/compiler-api.md | 9 --------- versioned_docs/version-v4.3/core/compiler-api.md | 9 --------- versioned_docs/version-v4.4/core/compiler-api.md | 9 --------- versioned_docs/version-v4.5/core/compiler-api.md | 9 --------- versioned_docs/version-v4.6/core/compiler-api.md | 9 --------- versioned_docs/version-v4.7/core/compiler-api.md | 9 --------- versioned_docs/version-v4.8/core/compiler-api.md | 9 --------- versioned_docs/version-v4.9/core/compiler-api.md | 9 --------- 16 files changed, 144 deletions(-) diff --git a/docs/core/compiler-api.md b/docs/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/docs/core/compiler-api.md +++ b/docs/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.0/core/compiler-api.md b/versioned_docs/version-v4.0/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.0/core/compiler-api.md +++ b/versioned_docs/version-v4.0/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.1/core/compiler-api.md b/versioned_docs/version-v4.1/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.1/core/compiler-api.md +++ b/versioned_docs/version-v4.1/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.10/core/compiler-api.md b/versioned_docs/version-v4.10/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.10/core/compiler-api.md +++ b/versioned_docs/version-v4.10/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.11/core/compiler-api.md b/versioned_docs/version-v4.11/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.11/core/compiler-api.md +++ b/versioned_docs/version-v4.11/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.12/core/compiler-api.md b/versioned_docs/version-v4.12/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.12/core/compiler-api.md +++ b/versioned_docs/version-v4.12/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.13.0/core/compiler-api.md b/versioned_docs/version-v4.13.0/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.13.0/core/compiler-api.md +++ b/versioned_docs/version-v4.13.0/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.14/core/compiler-api.md b/versioned_docs/version-v4.14/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.14/core/compiler-api.md +++ b/versioned_docs/version-v4.14/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.2/core/compiler-api.md b/versioned_docs/version-v4.2/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.2/core/compiler-api.md +++ b/versioned_docs/version-v4.2/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.3/core/compiler-api.md b/versioned_docs/version-v4.3/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.3/core/compiler-api.md +++ b/versioned_docs/version-v4.3/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.4/core/compiler-api.md b/versioned_docs/version-v4.4/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.4/core/compiler-api.md +++ b/versioned_docs/version-v4.4/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.5/core/compiler-api.md b/versioned_docs/version-v4.5/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.5/core/compiler-api.md +++ b/versioned_docs/version-v4.5/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.6/core/compiler-api.md b/versioned_docs/version-v4.6/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.6/core/compiler-api.md +++ b/versioned_docs/version-v4.6/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.7/core/compiler-api.md b/versioned_docs/version-v4.7/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.7/core/compiler-api.md +++ b/versioned_docs/version-v4.7/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.8/core/compiler-api.md b/versioned_docs/version-v4.8/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.8/core/compiler-api.md +++ b/versioned_docs/version-v4.8/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx diff --git a/versioned_docs/version-v4.9/core/compiler-api.md b/versioned_docs/version-v4.9/core/compiler-api.md index 399b4affa..b1c64bdc5 100644 --- a/versioned_docs/version-v4.9/core/compiler-api.md +++ b/versioned_docs/version-v4.9/core/compiler-api.md @@ -14,17 +14,8 @@ work within a NodeJS environment, web worker, and browser window. The ```tsx // NodeJS (commonjs) const stencil = require('@stencil/core/compiler'); - -// Web Worker from CDN URL (add the version to in the URL) -importScripts('https://cdn.jsdelivr.net/npm/@stencil/core@[VERSION]/compiler/stencil.min.js'); -// self.stencil will be available after the script import - -// Browser Window - -// window.stencil will be available after the script executes ``` - ## transpile() ```tsx