Skip to content
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.

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

Land #21 from docs.audius.org #3514

Merged
merged 1 commit into from
Aug 3, 2022
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
4 changes: 2 additions & 2 deletions docs/docs/developers/log-in-with-audius.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Log In with Audius lets you retrieve and verify a user's Audius profile informat
import Web3 from "web3";
import { sdk } from "@audius/sdk";

window.Web3 = Web3
window.Web3 = Web3;

const audiusSdk = sdk({ appName: "Name of your app goes here" });

Expand Down Expand Up @@ -76,7 +76,7 @@ audiusSdk.oauth.init(
/**
`res` will contain the following user information:
{
userId: number; // unique Audius user identifier
userId: string; // unique Audius user identifier
email: string;
name: string; // user's display name
handle: string;
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/developers/sdk-oauth-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ enables the Log In with Audius functionality.
```typescript
// type UserProfile =
{
userId: number; // unique Audius user identifier
userId: string; // unique Audius user identifier
email: string;
name: string; // user's display name
handle: string;
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/developers/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import Web3 from 'web3'
import { sdk } from '@audius/sdk'

// If running in a browser, set window.Web3
window.Web3 = Web3
window.Web3 = Web3;

const audiusSdk = sdk({ appName: 'Name of your app goes here' })

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ audiusSdk.oauth.init(
/**
`res` will contain the following user information:
{
userId: number; // unique Audius user identifier
userId: string; // unique Audius user identifier
email: string;
name: string; // user's display name
handle: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ enables the Log In with Audius functionality.
```typescript
// type UserProfile =
{
userId: number; // unique Audius user identifier
userId: string; // unique Audius user identifier
email: string;
name: string; // user's display name
handle: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ npm install web3

```js
import Web3 from 'web3'
window.Web3 = Web3
window.Web3 = Web3;
```

#### 3. Initialize the SDK
Expand All @@ -118,7 +118,7 @@ console.log(tracks, 'Tracks fetched!')
import Web3 from 'web3'
import { sdk } from '@audius/sdk'

window.Web3 = Web3
window.Web3 = Web3;
const audiusSdk = sdk({ appName: 'My Example App' })
const tracks = await audiusSdk.discoveryNode.getTracks()
console.log(tracks, 'Tracks fetched!')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Log In with Audius lets you retrieve and verify a user's Audius profile informat
import Web3 from "web3";
import { sdk } from "@audius/sdk";

window.Web3 = Web3
window.Web3 = Web3;

const audiusSdk = sdk({ appName: "Name of your app goes here" });

Expand Down Expand Up @@ -76,7 +76,7 @@ audiusSdk.oauth.init(
/**
`res` will contain the following user information:
{
userId: number; // unique Audius user identifier
userId: string; // unique Audius user identifier
email: string;
name: string; // user's display name
handle: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ enables the Log In with Audius functionality.
```typescript
// type UserProfile =
{
userId: number; // unique Audius user identifier
userId: string; // unique Audius user identifier
email: string;
name: string; // user's display name
handle: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import Web3 from 'web3'
import { sdk } from '@audius/sdk'

// If running in a browser, set window.Web3
window.Web3 = Web3
window.Web3 = Web3;

const audiusSdk = sdk({ appName: 'Name of your app goes here' })

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The Audius JavaScript (TypeScript) SDK allows you to easily build upon and inter
import { sdk } from '@audius/sdk'

// If running in a browser, set window.Web3
window.Web3 = Web3
window.Web3 = Web3;

const audiusSdk = sdk({ appName: 'My Example App' })

Expand Down