v0.3.0 bump

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v0.3.0
+
+- Add usage section in README.
+- More descriptive error message for `NotFoundError`.
+- Wake up model during `HostedModel` construction.
+- Add optional `pollIntervalMillis` parameter to `HostedModel.waitUntilAwake()` method.
+
 ## v0.2.0
 
 - Add CI/CD releases via CircleCI

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runwayml/hosted-models",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Interact with Runway Hosted Models with only a few lines of code!",
   "main": "build/index.js",
   "scripts": {

src/HostedModel.ts

@@ -78,6 +78,10 @@ export class HostedModel {
     if (this.token) this.headers['Authorization'] = `Bearer ${this.token}`;
     this.responseCodesToRetry = [502, 429];
     if (!this.isValidV1URL(this.url)) throw new InvlaidURLError();
+    // Wake up the model during construction because it will probably be used soon
+    this.root()
+      .then(result => result)
+      .catch(err => err);
   }
 
   /**
@@ -141,8 +145,11 @@ export class HostedModel {
    *  doSomething(output)
    * }
    * ```
+   *
+   * @param pollIntervalMillis [[waitUntilAwake]] The rate that this function will poll
+   * the hosted model endpoint to check if it is awake yet.
    */
-  async waitUntilAwake(): Promise<void> {
+  async waitUntilAwake(pollIntervalMillis = 1000): Promise<void> {
     return new Promise((resolve, reject) => {
       (async () => {
         try {
@@ -152,7 +159,7 @@ export class HostedModel {
               resolve();
               return;
             }
-            await delay(500);
+            await delay(pollIntervalMillis);
           }
         } catch (err) {
           reject(err);