Class: Tokenizer
Constructors
constructor
• new Tokenizer(config
)
Parameters
Name | Type |
---|---|
config | Partial <TokenizerClientConfig > |
Defined in
Properties
config
• Readonly
config: TokenizerClientConfig
Defined in
openApi
• Readonly
openApi: DefaultApi
Defined in
Methods
createGrant
▸ createGrant(sessionId
, tokenId
, customDuration?
): Promise
<TokenizerFailApiResponse
| { success
: boolean
}>
Parameters
Name | Type |
---|---|
sessionId | string |
tokenId | string |
customDuration? | string |
Returns
Promise
<TokenizerFailApiResponse
| { success
: boolean
}>
Defined in
verifyGrant
▸ verifyGrant(sessionId
, tokenId
): SuccessOrFailOutput
<TokenizerVerifyGrantResponse
>
Parameters
Name | Type |
---|---|
sessionId | string |
tokenId | string |
Returns
SuccessOrFailOutput
<TokenizerVerifyGrantResponse
>
Defined in
getMetadata
▸ getMetadata(tokenId
): SuccessOrFailOutput
<TokenizerGetMetadataResponse
>
Parameters
Name | Type |
---|---|
tokenId | string |
Returns
SuccessOrFailOutput
<TokenizerGetMetadataResponse
>
Defined in
tokenize
▸ tokenize(input
, metadata
): SuccessOrFailOutput
<TokenizerTokenizeResponse
>
Parameters
Name | Type |
---|---|
input | string | Buffer |
metadata | MetaData |
Returns
SuccessOrFailOutput
<TokenizerTokenizeResponse
>
Defined in
detokenize
▸ detokenize(tokenId
): SuccessOrFailOutput
<TokenizerDetokenizeResponse
>
Parameters
Name | Type |
---|---|
tokenId | string |
Returns
SuccessOrFailOutput
<TokenizerDetokenizeResponse
>
Defined in
detokenizeToUrl
▸ detokenizeToUrl(tokenId
): SuccessOrFailOutput
<TokenizerDetokenizeToUrlResponse
>
Parameters
Name | Type |
---|---|
tokenId | string |
Returns
SuccessOrFailOutput
<TokenizerDetokenizeToUrlResponse
>
Defined in
detokenizeToFileInfo
▸ detokenizeToFileInfo(token
): SuccessOrFailOutput
<TokenizerDetokenizeFileInfo
>
// Fetches file info and pre-signed URL needed to start a file download. Useful when we want to prepare the option to start a download but not yet start one. Grabs the file URL and metadata in parallel. Similar to detokenizeToUrl but for files
Parameters
Name | Type |
---|---|
token | string |
Returns
SuccessOrFailOutput
<TokenizerDetokenizeFileInfo
>
Defined in
detokenizeFileFromFileInfo
▸ detokenizeFileFromFileInfo(fileInfo
): SuccessOrFailOutput
<TokenizerDetokenizeFileResponse
>
BROWSER ONLY Triggers a download of a file that we already got the file info for using getFileInfo
Parameters
Name | Type | Description |
---|---|---|
fileInfo | FileInfo | LunaSec's custom FileInfo object which tells us about the tokenized file |
Returns
SuccessOrFailOutput
<TokenizerDetokenizeFileResponse
>
Defined in
detokenizeFile
▸ detokenizeFile(token
): SuccessOrFailOutput
<TokenizerDetokenizeFileResponse
>
BROWSER ONLY Takes a token and downloads and returns a File object, complete with proper name, mime type, and lastModified fields
Parameters
Name | Type |
---|---|
token | string |
Returns
SuccessOrFailOutput
<TokenizerDetokenizeFileResponse
>
Defined in
tokenizeFile
▸ tokenizeFile(file
, customMetadata?
): SuccessOrFailOutput
<TokenizerTokenizeResponse
>
BROWSER ONLY
uploads a file into LunaSec and returns a tokenId, just like tokenize
Parameters
Name | Type |
---|---|
file | File | FileWithPath |
customMetadata? | Record <string , unknown > |
Returns
SuccessOrFailOutput
<TokenizerTokenizeResponse
>