Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
j3lte committed Apr 12, 2023
1 parent c6426ca commit 251e812
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions src/Query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,33 @@ import { addExpr, expr } from "./utils/expr.ts";
import { FieldImpl } from "./Field.ts";

export interface AuthOpts {
/**
* API token
*
* The Socrata Open Data API uses application tokens for two purposes:
* Using an application token allows us to throttle by application, rather than via IP address, which gives you a higher throttling limit
* Authentication using OAuth
*
* Docs: https://dev.socrata.com/docs/app-tokens.html
*/
apiToken?: string;
/**
* Username (needs password) for Basic HTTP Auth
*
* Docs: https://dev.socrata.com/docs/authentication.html#authenticating-using-http-basic-authentication
*/
username?: string;
/**
* Password (needs username) for Basic HTTP Auth
*
* Docs: https://dev.socrata.com/docs/authentication.html#authenticating-using-http-basic-authentication
*/
password?: string;
/**
* OAuth Access Token
*
* Docs: https://dev.socrata.com/docs/authentication.html#using-an-oauth-20-access-token
*/
accessToken?: string;
}

Expand Down

0 comments on commit 251e812

Please sign in to comment.