diff --git a/src/Query.ts b/src/Query.ts index 44f0133..97cf3c7 100644 --- a/src/Query.ts +++ b/src/Query.ts @@ -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; }