separate validateClientIdentifier from fetchClientIdentifier, add validateProfile
[squeep-indieauth-helper] / README.md
1 # IndieAuth Helper
2
3 Just some abstractions for interacting with IndieAuth sites, basically wrapping axios and mf2 parsing.
4
5 This is currently quite opinionated, and likely is only really useful in the context of Squeep Framework Applications.
6
7 Notable methods on the Communication class:
8
9 - `static async generatePKCE(length)`
10 Create a code and verifier for use in an IndieAuth transaction.
11
12 - `async fetchProfile(urlObject)`
13 Retrieve profile information from an endpoint.
14
15 - `async validateClientIdentifier(url)`
16 Check that a url meets specification requirements to be a client identifier.
17
18 - `async fetchClientIdentifier(urlObject)`
19 Retrieve client identifier information from an endpoint.
20
21 - `async fetchMicroformat(urlObject)`
22 Retrieve all mf2 information from an endpoint.
23
24 - `async fetchJSON(urlObject)`
25 Retrieve json from an endpoint.