Skip to content

Main Navigation 指南 Apis 组件 Swagger

Appearance

Sidebar Navigation

api

app.module

classes

AppModule

index

constants

variables

jwtConstants

index

decorators

functions

Public

variables

IS_PUBLIC_KEY

index

filter

http-exception

http-exception.filter

classes

HttpExceptionFilter

index

interceptor

transform

transform.interceptor

classes

TransformInterceptor

index

main

index

modules

ai

ai.controller

classes

AIController

index

ai.module

classes

AIModule

index

ai.service

classes

AIService

index

dto

exam.dto

classes

index

grammar.dto

classes

index

test.dto

classes

index

grammar-analysis.service

classes

GrammarAnalysisService

index

prompts

exam-prompts

classes

index

grammar-prompts

classes

index

prompt-builder

classes

index

reading-prompts

classes

index

index

reading-generation.service

classes

ReadingGenerationService

index

types

exam.types

interfaces

index

grammar.types

enumerations

interfaces

variables

index

auth

auth.controller

classes

AuthController

index

auth.module

classes

AuthModule

index

auth.repository

classes

AuthRepository

index

auth.service

classes

AuthService

index

dto

login.dto

classes

index

register.dto

classes

index

send-email-code.dto

classes

index

entities

auth.entity

classes

index

jwt-auth.guard

classes

JwtAuthGuard

index

jwt-auth.strategy

classes

JwtAuthStrategy

interfaces

JwtPayload

index

books

books.controller

classes

BooksController

index

books.module

classes

BooksModule

index

books.repository

classes

BooksRepository

index

books.service

classes

BooksService

index

dto

books.dto

classes

index

learning

daily-plan.repository

classes

DailyPlanRepository

index

daily-plan.service

classes

DailyPlanService

index

dto

addBook.dto

classes

index

book-detail.dto

classes

index

currentBook.dto

classes

index

daily-plan.dto

classes

index

learning-stats.dto

classes

index

learning.controller

classes

LearningController

index

learning.module

classes

LearningModule

index

learning.repository

classes

LearningRepository

index

learning.service

classes

LearningService

index

types

type-aliases

AddUserLearning

index

logger

logger.module

classes

LoggerModule

index

logger.service

classes

LoggerService

index

prisma

prisma.module

classes

PrismaModule

index

prisma.service

classes

PrismaService

index

prisma.service.spec

index

quiz

dto

quiz.dto

classes

index

prompts

quiz-choice.prompts

classes

index

quiz-choice-generation.service

classes

QuizChoiceGenerationService

index

quiz-choice.repository

classes

QuizChoiceRepository

interfaces

CreateChoiceQuizData

GetQuizzesParams

index

quiz-choice.service

classes

QuizChoiceService

interfaces

WordWithMeanings

index

quiz.module

classes

QuizModule

index

types

quiz-choice.types

interfaces

index

redis

distributed-lock.decorator

classes

DistributedLockInterceptor

functions

DistributedLock

interfaces

DistributedLockDecoratorOptions

variables

DISTRIBUTED_LOCK_KEY

index

distributed-lock.service

classes

DistributedLockService

interfaces

LockOptions

LockResult

index

redis.module

classes

RedisModule

index

redis.service

classes

RedisService

index

speech

dto

pronunciation-assess-req.dto

classes

index

pronunciation-assess-res.dto

classes

index

index

speech.controller

classes

SpeechController

index

speech.module

classes

SpeechModule

index

speech.service

classes

SpeechService

index

user

user.controller

classes

UserController

index

user.module

classes

UserModule

index

user.repository

classes

UserRepository

index

user.service

classes

UserService

index

third-party-modules

variables

thirdPartyModules

index

types

index

utils

functions

generateVerificationCode

index

index

shared

enumerations

ExamType

GrammarTag

QuizQuestionType

WordLearningStatus

interfaces

AddBookReqDto

BatchUpdateWordsReqDto

BookDetailResDto

ClauseAnalysisDto

CreateQuizReqDto

CreateQuizResDto

DailyPlanWordDto

ExamChoice

ExamGenerationParams

ExamGenerationResult

ExamOptionDto

ExamQuestionDto

GenerateExamReqDto

GenerateExamResDto

GenerateReadingReqDto

GenerateReadingResDto

GetBooksResDto

GetCurrentBookResDto

GetDailyPlanReqDto

GetDailyPlanResDto

GetQuizDetailResDto

GetQuizListReqDto

GetQuizListResDto

LoginReqDto

LoginResDto

ParseGrammarReqDto

ParseGrammarResDto

ParseMultipleGrammarReqDto

ParseMultipleGrammarResDto

PhraseAnalysisDto

QuizChoiceOptionDto

QuizChoiceQuestionDto

QuizListItemDto

ReadingArticle

ReadingArticleDto

ReadingGenerationParams

ReadingGenerationResult

RegisterReqDto

RegisterResDto

SendEmailCodeReqDto

SentenceGrammarAnalysis

SentenceGrammarAnalysisDto

SRSCalculationResult

SubmitQuizAnswerReqDto

SubmitQuizAnswerResDto

UpdateWordStatusReqDto

Word

WordDto

WordGrammarAnalysis

WordGrammarAnalysisDto

WordInfoDto

variables

GrammarTagDescriptions

passwordRegExp

index

utils

functions

isEmail

variables

emailRegExp

passwordRegExp

index

web

App

functions

default

index

components

books

functions

default

index-1

index

button

Button

interfaces

ButtonProps

variables

Button

index

Button.stories

variables

Block

Default-1

default

LearningAppScenarios

Shapes

Sizes

States

Variants

WithIcons

index

index

card

Card

index

variables

Card

index

form

context

interfaces

FormContextValue

FormErrors

FormField

FormInstance

FormProps

FormValues

ValidationRule

variables

FormContext

index

Form

variables

Form

index

Form.stories

variables

ControlledForm

Default-1

default

FormSpacing

FormValidation

Layouts

LearningAppScenarios

index

hooks

functions

useForm

useFormContext

index

index

form-item

FormItem

interfaces

FormItemProps

variables

FormItem

index

FormItem.stories

variables

Default-1

default

DifferentControls

LabelAlignment

LabelPositions

LearningAppScenarios

RequiredAndHelp

ValidationStates

index

index

input

Input

interfaces

InputProps

variables

Input

index

Input.stories

variables

Controlled

Default-1

default

Features

LearningAppScenarios

PasswordInput

Sizes

States

WithIcons

index

index

page-header

PageHeader

index

index

reader

hooks

word-helper

functions

index

Reader

interfaces

ReaderParagraph

ReaderProps

variables

Reader

index

word-helper

WordHelper

interfaces

variables

index

index

theme-toggle

ThemeToggle

index

index

variables

PageHeader

ThemeToggle

WordList

virtual-popover

VirtualPopover

interfaces

VirtualPopoverProps

VirtualRect

variables

VirtualPopover

index

index

word-list

WordList

interfaces

WordItem

WordMeaning

index

index

index

hooks

useTheme

functions

useTheme

type-aliases

PrimaryColor

Theme

index

useVocabularyPractice

enumerations

LearningStage

functions

useVocabularyPractice

interfaces

UseVocabularyPracticeOptions

UseVocabularyPracticeReturn

index

index

index

layout

functions

default

tabbar

config

functions

shouldShowTabbar

variables

tabs

index

functions

Tabbar

index

index

main

index

modules

ai

api

functions

parseGrammar

parseMultipleGrammar

index

books

api

functions

addLearningBook

getBookDetail

getBooks

getCurrentBook

getDailyPlan

index

user

api

functions

changePassword

getUser

login

register

sendEmailCode

updateUserProfile

uploadAvatar

interfaces

ChangePasswordReq

ChangePasswordRes

UpdateUserProfileReq

UpdateUserProfileRes

index

store

variables

useUserStore

index

network

ai

classes

AIService

ExtendedAIService

interfaces

ChatCompletionParams

ChatMessage

ClozeArticle

ClozeGenerationParams

ClozeQuestion

StoryGenerationParams

StoryGenerationProgress

StreamHandler

Word

test

functions

quickTestConnection

testAIConnection

interfaces

TestConnectionRequest

TestConnectionResponse

index

variables

AI_CONFIG

aiService

client

index

learning

enumerations

WordLearningStatus

functions

batchUpdateWordStatus

getCurrentBook

getDailyPlan

getLearningStats

getTodayProgress

updateWordStatus

interfaces

BatchUpdateWordsRequest

CurrentBook

CurrentBookResponse

DailyPlanWord

ExampleSentence

GetDailyPlanRequest

GetDailyPlanResponse

LearningStats

QuizChoiceData

QuizChoiceOption

UpdateWordStatusRequest

WordMeaning

variables

learningApi

index

request

functions

request

types

interfaces

ApiResponse

index

variables

request

index

pages

404

functions

NotFound

index

ai

variables

default

index

ai-test

functions

default

index

book-detail

functions

default

index

books

variables

default

index-1

index

chat

functions

Chats

hooks

useAIChat

functions

interfaces

index

useChatHistory

functions

interfaces

index

useMarkdown

functions

index

index

cloze-test

variables

default

index

grammar-analysis

variables

default

index

login

hooks

useLogin

functions

index

variables

default

index

me

functions

default

index

onboarding

functions

default

index

profile

functions

default

index

reading

variables

default

index

register

functions

default

hooks

useEmailCode

functions

index

useRegister

functions

index

index

settings

variables

default

index

story-vocabulary

variables

default

index-1

index

test

functions

default

index

vocabulary-book

variables

default

index

vocabulary-learning

functions

default

index

vocabulary-practice

components

learning-complete

index

loading-error

index

variables

LearningComplete

LoadingError

WordDetailStage

WordLearningStage

WordPracticeHeader

word-detail-stage

index

word-learning-stage

index

word-practice-header

index

index

hooks

useVocabularyPractice

enumerations

functions

interfaces

index

index

variables

default

index

router

AuthGuard

functions

AuthGuard

index

Routes

interfaces

RouteItem

variables

routes

index

variables

router

index

sync-engine

db

index

SyncEngine

index

types

index

index

index

On this page

@sylis/web v0.0.0

@sylis/web / modules/books/api

modules/books/api

Functions

addLearningBook
getBookDetail
getBooks
getCurrentBook
getDailyPlan

Pager