fix: typedefs

This commit is contained in:
Daniel Salazar
2025-09-19 16:54:28 -07:00
parent d6fbe94364
commit 44284eb788
3 changed files with 27 additions and 6 deletions

View File

@@ -12,16 +12,37 @@ npm install @heyputer/puter.js
### Importing
### Node.js (with Auth Token)
```js
const {init} = require("@heyputer/puter.js/src/init.cjs"); // NODE JS ONLY
// or
import {init} from "@heyputer/puter.js/src/init.cjs";
const puter = init(process.env.puterAuthToken); // uses your auth token
const puter2 = init(process.env.puterAuthToken2); // use some other auth token
```
### Browser (without Auth Token)
#### ES Modules
```js
import '@heyputer/puter.js';
import {puter} from '@heyputer/puter.js';
// or
import puter from '@heyputer/puter.js';
// or
import '@heyputer/puter.js'; // puter will be available globally
```
#### CommonJS
```js
const {puter} = require('@heyputer/puter.js');
// or
const puter = require('@heyputer/puter.js');
// or
require('@heyputer/puter.js'); // puter will be available globally
```
#### CDN

View File

@@ -1,6 +1,6 @@
{
"name": "@heyputer/puter.js",
"version": "2.0.9",
"version": "2.0.11",
"description": "Puter.js - A JavaScript library for interacting with Puter services.",
"main": "src/index.js",
"types": "index.d.ts",

View File

@@ -2,11 +2,11 @@ const { readFileSync } = require('node:fs');
const vm = require('node:vm');
const { resolve } = require('node:path');
/**
* Method for loading puter.js in Node.js environment
* Method for loading puter.js in Node.js environment with auth token
* @param {string} authToken - Optional auth token to initialize puter with
* @returns {Promise<import('../index.d.ts').puter>} The `puter` object from puter.js
* @returns {import('../index').puter} The `puter` object from puter.js
*/
const safeLoadPuterJs = (authToken) => {
const init = (authToken) => {
const goodContext = {};
Object.getOwnPropertyNames(globalThis).forEach(name => {
try {
@@ -25,4 +25,4 @@ const safeLoadPuterJs = (authToken) => {
return goodContext.puter;
};
module.exports = { safeLoadPuterJs };
module.exports = { init };