Skip to content

Adjust formatting app methods #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reynaldichernando merged 1 commit into from
Dec 20, 2025
Merged

Adjust formatting app methods #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
92 changes: 61 additions & 31 deletions src/Objects/app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,46 +59,76 @@ A number containing the number of users that have access to the app. If the `sta

An object containing custom metadata for the app. This can be used to store arbitrary key-value pairs associated with the app.

#### `users()` (Async Iteratable)
## Methods

### `users()`

Iterates over all users of the apps.

__Syntax__

Iterates over all users of the apps. Each user is represented by an object which contains {username, user_uuid}.
```js
for await (const user of (await puter.apps.get("your-app-name")).users()) {
console.log(user)
}
app.users()
```

Prints:
```
>> {
"user": "user1",
"user_uuid": "b206196e-22eb-40bd-8d50-015239b7cd11"
}

>> {
"user": "user2",
"user_uuid": "b206196e-22eb-40bd-8d50-015239b7cd11"
}
__Parameters__

None.

__Return value__

Iterable objects each containing `{username, user_uuid}`.

__Example__

```html
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<script>
(async () => {
const app = (await puter.apps.get("stampy"));
for await (const user of app.users()) {
console.log(user)
}
})();
</script>
</body>
</html>
```

#### `getUsers({limit?: number, offset?: number})` (Async Function)
### `getUsers()`

Retrieves list of users one page at a time as defined by limit and offset.

Retrieves list of users one page at a time as defined by limit and offset. Default limit is 100, default offset is 0. Return's an array of users represented by an object which contains {username, user_uuid}.
__Syntax__

```js
const users = await (await puter.apps.get("your-app-name")).getUsers({limit: 2, offset: 0});
app.getUsers({ limit, offset })
```

Returns:
```
[
{
"user": "user1",
"user_uuid": "b206196e-22eb-40bd-8d50-015239b7cd11"
},
{
"user": "user2",
"user_uuid": "b206196e-22eb-40bd-8d50-015239b7cd11"
}
]
__Parameters__

- `limit` (Number) (optional): The number of users to retrieve. Default is 100.
- `offset` (Number) (optional): The offset to start retrieving users from. Default is 0.

__Return value__

An array of objects each containing `{username, user_uuid}`.

__Example__

```html
<html>
<body>
<script src="https://js.puter.com/v2/"></script>
<script>
(async () => {
const app = await puter.apps.get("your-app-name");
const users = await app.getUsers({limit: 2, offset: 0});
console.log(users);
})();
</script>
</body>
</html>
```