Repository files navigation

GitHub API authentication using a callback method

<scripttype="module">import{createCallbackAuth}from"https://esm.sh/@octokit/auth-callback";</script>

import{createCallbackAuth}from"@octokit/auth-callback";

lettoken;constauth=createCallbackAuth({callback:()=>token});awaitauth();// {//   type: 'unauthenticated'// }token="secret123";awaitauth();// {//   type: 'token',//   token: 'secret123',//   tokenType: 'oauth'// }

ThecreateCallbackAuth method accepts a singleoptions parameter

The asyncauth() method does not accept any arguments

The asyncauth() method resolves to one of two possible authentication objects

1. Unauthenticated if thecallback() returns or resolves a falsy value
2. Token authentication if thecallback() returns or resolves with a string value

auth.hook() hooks directly into the request life cycle. It amends the request to authenticate correctly based on the request URL.

Therequest option is an instance of@octokit/request. Theroute/options parameters are the same as for therequest() method.

auth.hook() can be called directly to send an authenticated request

const{data:user}=awaitauth.hook(request,"GET /user");

Or it can be passed as option torequest().

constrequestWithAuth=request.defaults({request:{hook:auth.hook,},});const{data:user}=awaitrequestWithAuth("GET /user");

SeeCONTRIBUTING.md

MIT