sdk/lib/generators
Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.
Functions
Section titled “Functions”generateRandomIDNumber()
Section titled “generateRandomIDNumber()”function generateRandomIDNumber(length: number): numberDefined in: studiocms/packages/studiocms/src/sdk/lib/generators.ts:9
Generates a random ID number with the specified length.
Parameters
Section titled “Parameters”length
Section titled “length”number
The length of the random ID number to generate.
Returns
Section titled “Returns”number
A random ID number with the specified length.
generateRandomPassword()
Section titled “generateRandomPassword()”function generateRandomPassword(length: number): stringDefined in: studiocms/packages/studiocms/src/sdk/lib/generators.ts:40
Generates a random password of the specified length.
Parameters
Section titled “Parameters”length
Section titled “length”number
The length of the password to generate.
Returns
Section titled “Returns”string
A randomly generated password string containing uppercase letters, lowercase letters, and digits.
generateToken()
Section titled “generateToken()”function generateToken(userId: string, noExpire?: boolean): stringDefined in: studiocms/packages/studiocms/src/sdk/lib/generators.ts:19
Generates a JSON Web Token (JWT) for a given user ID.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
The unique identifier of the user for whom the token is being generated.
noExpire?
Section titled “noExpire?”boolean
Returns
Section titled “Returns”string
A signed JWT string that expires in 3 hours.
testToken()
Section titled “testToken()”function testToken(token: string): JwtVerificationResultDefined in: studiocms/packages/studiocms/src/sdk/lib/generators.ts:30
Verifies the provided JWT token using the CMS encryption key.
Parameters
Section titled “Parameters”string
The JWT token to be verified.
Returns
Section titled “Returns”JwtVerificationResult
The decoded token if verification is successful.
Throws
Section titled “Throws”Will throw an error if the token is invalid or verification fails.