From c7b1777c27899e6c53bfed0513167572364fa8cc Mon Sep 17 00:00:00 2001 From: karthik2804 Date: Thu, 21 Nov 2024 11:31:44 +0100 Subject: [PATCH] make spin2 default and bump patch version Signed-off-by: karthik2804 --- package-lock.json | 4 ++-- package.json | 4 ++-- src/postgresv3.ts | 8 ++++++++ 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5dafebf0..32274c8a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@fermyon/spin-sdk", - "version": "2.3.0", + "version": "2.3.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@fermyon/spin-sdk", - "version": "2.3.0", + "version": "2.3.1", "hasInstallScript": true, "license": "Apache-2.0", "dependencies": { diff --git a/package.json b/package.json index e53c6632..af53b995 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fermyon/spin-sdk", - "version": "2.3.0", + "version": "2.3.1", "description": "", "main": "lib/index.js", "typings": "lib/index.d.ts", @@ -13,7 +13,7 @@ "fmt-check": "prettier --check \"src/**/*.{ts,tsx,js,jsx}\"", "build": "tsc && cp -r src/types ./lib/", "build-docs": "typedoc --plugin typedoc-plugin-missing-exports src/index.ts --out ./docs --excludeExternals --readme none", - "postinstall": "knitwit-postinstall --wit-path ../../bin/wit --world spin3-imports", + "postinstall": "knitwit-postinstall --wit-path ../../bin/wit --world spin-imports", "fmt-examples": "prettier --write \"examples/**/*.{ts,tsx,js,jsx}\" --ignore-patterm \"node_modules\"" }, "sideEffects": false, diff --git a/src/postgresv3.ts b/src/postgresv3.ts index f630d722..cf365d03 100644 --- a/src/postgresv3.ts +++ b/src/postgresv3.ts @@ -1,3 +1,11 @@ +/** + * PostgresV3 enables interacting with a Postgres database using Spin's v3 interface. + * To use this module you need to add `spin3-imports` to your `knitwit.json` file and run + * `npx knitwit`. + * + * @module PostgresV3 + */ + //@ts-ignore import * as spinPg from 'spin:postgres/postgres@3.0.0';