Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/AI/chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Given a prompt returns the completion that best matches the prompt.
## Syntax

```js
puter.ai.chat(prompt);
puter.ai.chat(prompt, (options = {}));
puter.ai.chat(prompt, (testMode = false), (options = {}));
puter.ai.chat(prompt, imageURL, (testMode = false), (options = {}));
puter.ai.chat(prompt, [imageURLArray], (testMode = false), (options = {}));
puter.ai.chat([messages], (testMode = false), (options = {}));
puter.ai.chat(prompt)
puter.ai.chat(prompt, options = {})
puter.ai.chat(prompt, testMode = false, options = {})
puter.ai.chat(prompt, imageURL, testMode = false, options = {})
puter.ai.chat(prompt, [imageURLArray], testMode = false, options = {})
puter.ai.chat([messages], testMode = false, options = {})
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/AI/img2txt.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Given an image will return the text contained in the image. Also known as OCR (O
## Syntax

```js
puter.ai.img2txt(image, (testMode = false));
puter.ai.img2txt(image, testMode = false)
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions src/AI/txt2img.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Given a prompt, generate an image using AI.
## Syntax

```js
puter.ai.txt2img(prompt, (testMode = false))
puter.ai.txt2img(prompt, (options = {}))
puter.ai.txt2img(prompt, testMode = false)
puter.ai.txt2img(prompt, options = {})
```

## Parameters
Expand Down
8 changes: 4 additions & 4 deletions src/Apps/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Creates a Puter app with the given name. The app will be created in the user's a
## Syntax

```js
puter.apps.create(name, indexURL);
puter.apps.create(name, indexURL, title);
puter.apps.create(name, indexURL, title, description);
puter.apps.create(options);
puter.apps.create(name, indexURL)
puter.apps.create(name, indexURL, title)
puter.apps.create(name, indexURL, title, description)
puter.apps.create(options)
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Apps/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Deletes an app with the given name.
## Syntax

```js
puter.apps.delete(name);
puter.apps.delete(name)
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions src/Apps/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Returns an app with the given name. If the app does not exist, the promise will
## Syntax

```js
puter.apps.get(name);
puter.apps.get(name, options);
puter.apps.get(name)
puter.apps.get(name, options)
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions src/Apps/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Returns an array of all apps belonging to the user and that this app has access
## Syntax

```js
puter.apps.list();
puter.apps.list(options);
puter.apps.list()
puter.apps.list(options)
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/getDetailedAppUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Users can only see the usage of applications they have accessed before.
## Syntax

```js
puter.auth.getDetailedAppUsage(appId);
puter.auth.getDetailedAppUsage(appId)
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/getMonthlyUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Get the user's current monthly resource usage in the Puter ecosystem.
## Syntax

```js
puter.auth.getMonthlyUsage();
puter.auth.getMonthlyUsage()
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/getUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Returns the user's basic information.
## Syntax

```js
puter.auth.getUser();
puter.auth.getUser()
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/isSignedIn.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Checks whether the user is signed into the application.
## Syntax

```js
puter.auth.isSignedIn();
puter.auth.isSignedIn()
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions src/Auth/signIn.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ The `puter.auth.signIn()` function must be triggered by a user action (such as a
## Syntax

```js
puter.auth.signIn();
puter.auth.signIn(options);
puter.auth.signIn()
puter.auth.signIn(options)
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Auth/signOut.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Signs the user out of the application.
## Syntax

```js
puter.auth.signOut();
puter.auth.signOut()
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions src/FS/copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Copies a file or directory from one location to another.
## Syntax

```js
puter.fs.copy(source, destination);
puter.fs.copy(source, destination, options);
puter.fs.copy(source, destination)
puter.fs.copy(source, destination, options)
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions src/FS/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Deletes a file or directory.
## Syntax

```js
puter.fs.delete(path);
puter.fs.delete(path, options);
puter.fs.delete(path)
puter.fs.delete(path, options)
```

## Parameters
Expand Down
9 changes: 5 additions & 4 deletions src/FS/getReadURL.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ platforms: [websites, apps, nodejs, workers]
Generates a URL that can be used to read a file.

## Syntax
```javascript
puter.fs.getReadURL(path);
puter.fs.getReadURL(path, expiresIn);

```js
puter.fs.getReadURL(path)
puter.fs.getReadURL(path, expiresIn)
```

## Parameters
Expand All @@ -30,4 +31,4 @@ A promise that resolves to a URL string that can be used to read the file.

```javascript
const url = await puter.fs.getReadURL("~/myfile.txt");
```
```
2 changes: 1 addition & 1 deletion src/Hosting/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Deletes a subdomain from your account. The subdomain will no longer be served by
## Syntax

```js
puter.hosting.delete(subdomain);
puter.hosting.delete(subdomain)
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Hosting/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Updates a subdomain to point to a new directory. If directory is not specified,
## Syntax

```js
puter.hosting.update(subdomain, dirPath);
puter.hosting.update(subdomain, dirPath)
```

## Parameters
Expand Down
6 changes: 3 additions & 3 deletions src/KV/decr.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Decrements the value of a key. If the key does not exist, it is initialized with
## Syntax

```js
puter.kv.decr(key);
puter.kv.decr(key, amount);
puter.kv.decr(key, pathAndAmount);
puter.kv.decr(key)
puter.kv.decr(key, amount)
puter.kv.decr(key, pathAndAmount)
```

## Parameters
Expand Down
6 changes: 3 additions & 3 deletions src/KV/incr.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Increments the value of a key. If the key does not exist, it is initialized with
## Syntax

```js
puter.kv.incr(key);
puter.kv.incr(key, amount);
puter.kv.incr(key, pathAndAmount);
puter.kv.incr(key)
puter.kv.incr(key, amount)
puter.kv.incr(key, pathAndAmount)
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/UI/hideWindow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The `hideWindow` method allows you to hide the window of your application.
## Syntax

```javascript
puter.ui.hideWindow();
puter.ui.hideWindow()
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/UI/showWindow.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The `showWindow` method allows you to show the window of your application.
## Syntax

```javascript
puter.ui.showWindow();
puter.ui.showWindow()
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Utils/appID.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A property of the `puter` object that returns the App ID of the running applicat
## Syntax

```js
puter.appID;
puter.appID
```

## Examples
Expand Down
2 changes: 1 addition & 1 deletion src/Utils/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A property of the `puter` object that returns the environment in which Puter.js
## Syntax

```js
puter.env;
puter.env
```

## Return value
Expand Down
2 changes: 1 addition & 1 deletion src/Utils/print.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Prints a string by appending it to the body of the document. This is useful for
## Syntax

```js
puter.print(text);
puter.print(text)
```

## Parameters
Expand Down
4 changes: 2 additions & 2 deletions src/Utils/randName.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ A function that generates a domain-safe name by combining a random adjective, a
## Syntax

```js
puter.randName();
puter.randName(separator);
puter.randName()
puter.randName(separator)
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Workers/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Sends a request to a worker endpoint while automatically passing your authentica
## Syntax

```js
puter.workers.exec(workerURL, options);
puter.workers.exec(workerURL, options)
```

## Parameters
Expand Down
2 changes: 1 addition & 1 deletion src/Workers/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Lists all workers in your account with their details.
## Syntax

```js
puter.workers.list();
puter.workers.list()
```

## Parameters
Expand Down