docs(lib): rename model to plugin remove new and add await keywords

Green-Software-Foundation · Feb 29, 2024 · 3c0c2fe · 3c0c2fe
1 parent 5fa4671
commit 3c0c2fe
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 18 deletions.
diff --git a/src/lib/ccf/README.md b/src/lib/ccf/README.md
@@ -54,7 +54,7 @@ You can see example Typescript invocations for each `cloud/vendor` below:
 import {CloudCarbonFootprint} from '@grnsft/if-unofficial-plugins';
 
 const ccf = CloudCarbonFootprint({interpolation: Interpolation.LINEAR});
-const results = ccf.execute([
+const results = await ccf.execute([
   {
     timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp
     duration: 3600, // duration institute
@@ -70,8 +70,8 @@ const results = ccf.execute([
 ```typescript
 import {CloudCarbonFootprint} from '@grnsft/if-unofficial-plugins';
 
-const ccf = new CloudCarbonFootprint();
-const results = ccf.execute([
+const ccf = CloudCarbonFootprint();
+const results = await ccf.execute([
   {
     timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp
     duration: 3600, // duration institute
@@ -87,8 +87,8 @@ const results = ccf.execute([
 ```typescript
 import {CloudCarbonFootprint} from '@grnsft/if-unofficial-plugins';
 
-const ccf = new CloudCarbonFootprint();
-const results = ccf.execute([
+const ccf = CloudCarbonFootprint();
+const results = await ccf.execute([
   {
     timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp
     duration: 3600, // duration institute

diff --git a/src/lib/co2js/README.md b/src/lib/co2js/README.md
@@ -6,7 +6,7 @@
 
 ## Plugin global config
 
-- `options`: **SWD Model Only** an object containing any Sustainable Web Design specific variables to the changed. All keys are optional.
+- `options`: **SWD Plugin Only** an object containing any Sustainable Web Design specific variables to the changed. All keys are optional.
   - `dataReloadRatio` - a value between 0 and 1 representing the percentage of data that is downloaded by return visitors. -`firstVisitPercentage` - a value between 0 and 1 representing the percentage of new visitors.
   - `returnVisitPercentage` - a value between 0 and 1 representing the percentage of returning visitors.
   - `gridIntensity` - an object that can contain the following optional keys:
@@ -94,13 +94,13 @@ This yields a result that looks like the following (saved to `/outputs/co2js.yml
 
 ```yaml
 name: co2js-demo
-description: example manifest invoking CO2.JS model
+description: example manifest invoking CO2.JS plugin
 tags: null
 initialize:
   plugins:
     co2js:
-      path: '@grnsft/if-unofficial-models'
-      model: Co2js
+      path: '@grnsft/if-unofficial-plugins'
+      method: Co2js
       global-config:
         options:
           dataReloadRatio: 0.6
@@ -153,7 +153,7 @@ const globalConfig = {
   },
 };
 const co2js = Co2js(globalConfig);
-const results = co2js.execute(
+const results = await co2js.execute(
   [
     {
       duration: 3600, // duration institute
@@ -174,7 +174,7 @@ const results = co2js.execute(
 import {Co2js} from '@grnsft/if-unofficial-plugins';
 
 const co2js = Co2js();
-const results = co2js.execute(
+const results = await co2js.execute(
   [
     {
       duration: 3600, // duration institute

diff --git a/src/lib/teads-aws/README.md b/src/lib/teads-aws/README.md
@@ -41,7 +41,7 @@ Resulting values are an estimate based on the testing done by Teads' Engineering
 import {TeadsAWS} from '@grnsft/if-unofficial-plugins';
 
 const teads = TeadsAWS({});
-const results = teads.execute([
+const results = await teads.execute([
   {
     duration: 3600, // duration institute
     timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp

diff --git a/src/lib/teads-curve/README.md b/src/lib/teads-curve/README.md
@@ -42,7 +42,7 @@ import {TeadsCurve} from '@grnsft/if-unofficial-plugins';
 const teads = TeadsCurve({
   'cpu/thermal-design-power': 100, // cpu/thermal-design-power of the CPU
 });
-const results = teads.execute([
+const results = await teads.execute([
   {
     duration: 3600, // duration institute
     timestamp: '2021-01-01T00:00:00Z', // ISO8601 / RFC3339 timestamp
@@ -66,7 +66,7 @@ Resulting values are an estimate based on the testing done by Teads' Engineering
 import {TeadsCurve, Interpolation} from '@grnsft/if-unofficial-plugins';
 
 const teads = TeadsCurve({interpolation: Interpolation.SPLINE});
-const results = teads.execute(
+const results = await teads.execute(
   [
     {
       duration: 3600, // duration institute

diff --git a/src/lib/watt-time/README.md b/src/lib/watt-time/README.md
@@ -55,18 +55,17 @@ WattTime API requires activation of subscription before usage. Please refer to t
 // export WATT_TIME_USERNAME=test1
 // export WATT_TIME_PASSWORD=test2
 // use environment variables to configure the plugin
-const output = await WattTimeGridEmissions({
+const output = WattTimeGridEmissions({
   username: process.env.WATT_TIME_USERNAME,
   password: process.env.WATT_TIME_PASSWORD,
 });
-const inputs = [
+const result = await output.execute([
   {
     timestamp: '2021-01-01T00:00:00Z',
     geolocation: '43.22,-80.22',
     duration: 3600,
   },
-];
-const results = output.execute(inputs);
+]);
 ```
 
 ### manifest Usage