Skip to content

update readme with up-to-date auth example #15

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

Open
pagdot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update readme with up-to-date auth example #15

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
29 changes: 21 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,28 @@ This library uses & collaborates with the **[Floatplane API Specification](https
### Example Usage

```ts
import { Floatplane } from "./index.js";
import { Floatplane, type AuthToken, OnDeviceCode } from 'floatplane';

const floatplane = new Floatplane(); // Create a new API instance.
class AuthTokenStore {
authToken?: AuthToken;
}

// login -> User object
const { user } = await floatplane.login({
username: "yourUsername",
password: "yourPassword",
token: "yourTokenIfYouUse2Factor",
const onDeviceCode: OnDeviceCode = async ({ verification_uri_complete, verification_uri }) => {
const verifyUri = verification_uri_complete ?? verification_uri;
console.log(`Please login to Floatplane via ${verifyUri}`);
};

const authTokenStore = new AuthTokenStore();

const floatplane = new Floatplane({
authConfig: {
clientId: "example-client", // Has to be registered on FloatPlane
authToken: authTokenStore.authToken,
onAuthToken: (authToken) => {authTokenStore.authToken = authToken},
onDeviceCode,
},
userAgent: `ExampleApp`, // Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/User-Agent
});
console.log(user);

// Fetch User subscriptions
const subs = await floatplane.user.subscriptions();
Expand All @@ -39,6 +50,8 @@ for await (const video of floatplane.creator.blogPostsIterable(subs[0].creator,
}
```

Take a look at https://github.com/Inrixia/Floatplane-Downloader/blob/055e21e42c0af89a68cdf2f58a195cc81ad07ddf/src/lib/helpers/index.ts#L49-L58 for a reference implementation.

Individual classes can also be imported seperately:

```ts
Expand Down