Update README.md

leehj050211 · Nov 7, 2023 · b9d99cb · b9d99cb
1 parent 85c6d61
commit b9d99cb
Showing 1 changed file with 49 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -24,28 +24,14 @@ import BsmOauth, {
 // BSM OAuth 객체 초기화
 const bsmOauth = new BsmOauth(BSM_AUTH_CLIENT_ID, BSM_AUTH_CLIENT_SECRET);
 
-try {
-  // 인증코드로 토큰 발급
-  const token = await bsmOauth.getToken(authCode);
+// 인증코드로 토큰 발급
+const token = await bsmOauth.getToken(authCode);
 
-  // 토큰으로 유저 정보 가져오기
-  const resource = await bsmOauth.getResource(token);
+// 토큰으로 유저 정보 가져오기
+const resource = await bsmOauth.getResource(token);
 
-  // 가져온 유저 정보 확인
-  console.log(resource.userCode);
-} catch (error) {
-  if (error instanceof BsmOauthError) {
-    if (error.type === BsmOauthErrorType.INVALID_CLIENT) {
-      // 클라이언트 정보가 잘못되었을 때
-    }
-    if (error.type === BsmOauthErrorType.AUTH_CODE_NOT_FOUND) {
-      // 인증코드를 찾을 수 없을 때
-    }
-    if (error.type === BsmOauthErrorType.TOKEN_NOT_FOUND) {
-      // 토큰을 찾을 수 없을 때
-    }
-  }
-}
+// 가져온 유저 정보 확인
+console.log(resource);
 ```
 
 ### JavaScript
@@ -62,30 +48,35 @@ const {
 
 const bsmOauth = new BsmOauth(BSM_AUTH_CLIENT_ID, BSM_AUTH_CLIENT_SECRET);
 
-(async () => {
-  try {
-    // 인증코드로 토큰 발급
-    const token = await bsmOauth.getToken(authCode);
-
-    // 토큰으로 유저 정보 가져오기
-    const resource = await bsmOauth.getResource(token);
-
-    // 가져온 유저 정보 확인
-    console.log(resource.userCode);
-  } catch (error) {
-    if (error instanceof BsmOauthError) {
-      if (error.type === BsmOauthErrorType.INVALID_CLIENT) {
-        // 클라이언트 정보가 잘못되었을 때
-      }
-      if (error.type === BsmOauthErrorType.AUTH_CODE_NOT_FOUND) {
-        // 인증코드를 찾을 수 없을 때
-      }
-      if (error.type === BsmOauthErrorType.TOKEN_NOT_FOUND) {
-        // 토큰을 찾을 수 없을 때
-      }
-    }
+// 인증코드로 토큰 발급
+const token = await bsmOauth.getToken(authCode);
+
+// 토큰으로 유저 정보 가져오기
+return await bsmOauth.getResource(token);
+
+// 가져온 유저 정보 확인
+console.log(resource);
+```
+
+### 예외 처리하기
+```javascript
+try {
+  const token = await bsmOauth.getToken(authCode);
+  await bsmOauth.getResource(token);
+} catch (error) {
+  if (!(error instanceof BsmOauthError)) {
+    return;
+  }
+  if (error.type === BsmOauthErrorType.INVALID_CLIENT) {
+    // 클라이언트 정보가 잘못되었을 때
+  }
+  if (error.type === BsmOauthErrorType.AUTH_CODE_NOT_FOUND) {
+    // 인증코드를 찾을 수 없을 때
   }
-})();
+  if (error.type === BsmOauthErrorType.TOKEN_NOT_FOUND) {
+    // 토큰을 찾을 수 없을 때
+  }
+}
 ```
 
 ### 학생, 선생님계정 구분하기
@@ -95,11 +86,24 @@ role 속성으로 구분할 수 있습니다.
 ```javascript
 // TypeScript에서는 role로 타입을 추론해야 학생 및 선생님 정보에 접근 가능합니다.
 if (resource.role === BsmUserRole.STUDENT) {
-  // 학생 이름 확인
-  console.log(resource.student.name);
+  // 학생 이름과 번호 확인
+  console.log(resource.student.name, resource.student.studentNo);
 }
 if (resource.role === BsmUserRole.TEACHER) {
   // 선생님 이름 확인
   console.log(resource.teacher.name);
 }
 ```
+
+### 학생, 선생님의 고유 정보에 바로 접근하기
+
+getRawResource 메서드로 원시 데이터를 가져올 수 있습니다.
+
+```typescript
+const rawResource: RawBsmOAuthResource = await bsmOauth.getRawResource(token);
+// 학생 또는 선생님의 이름 확인
+console.log(rawResource.name);
+
+// 학생의 번호 확인 (만약 resource.role이 TEACHER일 경우 undefined가 출력됩니다.)
+console.log(rawResource.studentNo);
+```