loadModule() and remove isReady()

Author: pyramation

README.md

@@ -183,29 +183,49 @@ const result = parseQueryDetailedSync('SELECT * FROM users WHERE active = true')
 // Returns: DetailedParseResult with enhanced error information if parsing fails
 ```
 
-### `isReady(): boolean`
+### Initialization
 
-Checks if the WebAssembly module is initialized and ready for synchronous operations. This is only needed when using the synchronous methods (`parseQuerySync`, `deparseSync`, etc.).
+The library provides both async and sync methods. Async methods handle initialization automatically, while sync methods require explicit initialization.
+
+#### Async Methods (Recommended)
+
+Async methods handle initialization automatically and are always safe to use:
 
 ```typescript
-import { isReady, parseQuerySync } from 'libpg-query';
-
-// Check if module is ready before using sync methods
-if (isReady()) {
-  const result = parseQuerySync('SELECT * FROM users');
-} else {
-  // Module needs initialization
-  console.warn('WASM module not initialized. Use async methods first to initialize.');
-}
+import { parseQuery, deparse } from 'libpg-query';
 
-// Recommended pattern for sync methods
-if (!isReady()) {
-  throw new Error('WASM module not initialized. Use async methods first to initialize.');
-}
+// These handle initialization automatically
+const result = await parseQuery('SELECT * FROM users');
+const sql = await deparse(result[0]);
+```
+
+#### Sync Methods
+
+Sync methods require explicit initialization using `loadModule()`:
+
+```typescript
+import { loadModule, parseQuerySync } from 'libpg-query';
+
+// Initialize first
+await loadModule();
+
+// Now safe to use sync methods
+const result = parseQuerySync('SELECT * FROM users');
+```
+
+### `loadModule(): Promise<void>`
+
+Explicitly initializes the WASM module. Required before using any sync methods.
+
+```typescript
+import { loadModule, parseQuerySync } from 'libpg-query';
+
+// Initialize before using sync methods
+await loadModule();
 const result = parseQuerySync('SELECT * FROM users');
 ```
 
-Note: The async methods (`parseQuery`, `deparse`, `parsePlPgSQL`, etc.) handle initialization automatically and are always safe to use. The `isReady()` check is only needed for the synchronous versions of these methods.
+Note: We recommend using async methods as they handle initialization automatically. Use sync methods only when necessary, and always call `loadModule()` first.
 
 ### Type Definitions
 

wasm/index.js

@@ -6,6 +6,13 @@ const initPromise = PgQueryModule().then((module) => {
   wasmModule = module;
 });
 
+export async function loadModule() {
+  if (!wasmModule) {
+    await initPromise;
+  }
+  return wasmModule;
+}
+
 function awaitInit(fn) {
   return async (...args) => {
     await initPromise;
@@ -164,8 +171,6 @@ export const normalize = awaitInit(async (query) => {
   }
 });
 
-
-
 export const parseQueryDetailed = awaitInit(async (query) => {
   const queryPtr = stringToPtr(query);
   let resultPtr;
@@ -207,7 +212,7 @@ export const parseQueryDetailed = awaitInit(async (query) => {
 
 export function parseQuerySync(query) {
   if (!wasmModule) {
-    throw new Error('WASM module not initialized. Call an async method first to initialize.');
+    throw new Error('WASM module not initialized. Call loadModule() first.');
   }
   const queryPtr = stringToPtr(query);
   let resultPtr;
@@ -252,7 +257,7 @@ export function parseQuerySync(query) {
 
 export function deparseSync(parseTree) {
   if (!wasmModule) {
-    throw new Error('WASM module not initialized. Call an async method first to initialize.');
+    throw new Error('WASM module not initialized. Call loadModule() first.');
   }
   const protobufData = protobufCache.get(parseTree);
 
@@ -283,7 +288,7 @@ export function deparseSync(parseTree) {
 
 export function parsePlPgSQLSync(query) {
   if (!wasmModule) {
-    throw new Error('WASM module not initialized. Call an async method first to initialize.');
+    throw new Error('WASM module not initialized. Call loadModule() first.');
   }
   const queryPtr = stringToPtr(query);
   let resultPtr;
@@ -307,7 +312,7 @@ export function parsePlPgSQLSync(query) {
 
 export function fingerprintSync(query) {
   if (!wasmModule) {
-    throw new Error('WASM module not initialized. Call an async method first to initialize.');
+    throw new Error('WASM module not initialized. Call loadModule() first.');
   }
   const queryPtr = stringToPtr(query);
   let resultPtr;
@@ -331,7 +336,7 @@ export function fingerprintSync(query) {
 
 export function normalizeSync(query) {
   if (!wasmModule) {
-    throw new Error('WASM module not initialized. Call an async method first to initialize.');
+    throw new Error('WASM module not initialized. Call loadModule() first.');
   }
   const queryPtr = stringToPtr(query);
   let resultPtr;
@@ -355,7 +360,7 @@ export function normalizeSync(query) {
 
 export function parseQueryDetailedSync(query) {
   if (!wasmModule) {
-    throw new Error('WASM module not initialized. Call an async method first to initialize.');
+    throw new Error('WASM module not initialized. Call loadModule() first.');
   }
   const queryPtr = stringToPtr(query);
   let resultPtr;
@@ -394,7 +399,3 @@ export function parseQueryDetailedSync(query) {
     wasmModule._free(queryPtr);
   }
 }
-
-export function isReady() {
-  return !!wasmModule;
-}