Endo API documentation - v0.2.0 / Exports / @endo/lockdown

Module: @endo/lockdown

Table of contents

Interfaces

• AssertMakeErrorOptions
• AssertionFunctions
• AssertionUtilities
• CompartmentEvaluateOptions
• CompartmentOptions
• DeprecatedAssertionUtilities
• EvaluateOptions
• PrecompiledStaticModuleInterface
• RedirectStaticModuleInterface
• RepairOptions
• ThirdPartyStaticModuleInterface
• ToStringable

Type Aliases

• Assert
• AssertTypeof
• AssertTypeofBigint
• AssertTypeofBoolean
• AssertTypeofFunction
• AssertTypeofNumber
• AssertTypeofObject
• AssertTypeofString
• AssertTypeofSymbol
• AssertTypeofUndefined
• Details
• DetailsToken
• FinalStaticModuleType
• GenericErrorConstructor
• Harden
• HardenIntrinsics
• ImportHook
• Lockdown
• LockdownOptions
• MakeAssert
• ModuleExportsNamespace
• ModuleMap
• ModuleMapHook
• Raise
• RepairIntrinsics
• ResolveHook
• StaticModuleType
• Transform
• __FixedExportMap__
• __LiveExportMap__

Variables

• lockdown

Type Aliases

Assert

Ƭ Assert: AssertionFunctions & AssertionUtilities & DeprecatedAssertionUtilities

Defined in

ses/types.d.ts:232

---

AssertTypeof

Ƭ AssertTypeof: AssertTypeofBigint & AssertTypeofBoolean & AssertTypeofFunction & AssertTypeofNumber & AssertTypeofObject & AssertTypeofString & AssertTypeofSymbol & AssertTypeofUndefined

Defined in

ses/types.d.ts:167

---

AssertTypeofBigint

Ƭ AssertTypeofBigint: (specimen: any, typeName: "bigint", details?: Details) => asserts specimen is bigint

Type declaration

▸ (specimen, typeName, details?): asserts specimen is bigint

Parameters

Name	Type
specimen	any
typeName	"bigint"
details?	Details

Returns

asserts specimen is bigint

Defined in

ses/types.d.ts:126

---

AssertTypeofBoolean

Ƭ AssertTypeofBoolean: (specimen: any, typeName: "boolean", details?: Details) => asserts specimen is boolean

Type declaration

▸ (specimen, typeName, details?): asserts specimen is boolean

Parameters

Name	Type
specimen	any
typeName	"boolean"
details?	Details

Returns

asserts specimen is boolean

Defined in

ses/types.d.ts:131

---

AssertTypeofFunction

Ƭ AssertTypeofFunction: (specimen: any, typeName: "function", details?: Details) => asserts specimen is Function

Type declaration

▸ (specimen, typeName, details?): asserts specimen is Function

Parameters

Name	Type
specimen	any
typeName	"function"
details?	Details

Returns

asserts specimen is Function

Defined in

ses/types.d.ts:136

---

AssertTypeofNumber

Ƭ AssertTypeofNumber: (specimen: any, typeName: "number", details?: Details) => asserts specimen is number

Type declaration

▸ (specimen, typeName, details?): asserts specimen is number

Parameters

Name	Type
specimen	any
typeName	"number"
details?	Details

Returns

asserts specimen is number

Defined in

ses/types.d.ts:141

---

AssertTypeofObject

Ƭ AssertTypeofObject: (specimen: any, typeName: "object", details?: Details) => asserts specimen is Record<any, any> | null

Type declaration

▸ (specimen, typeName, details?): asserts specimen is Record<any, any> | null

Parameters

Name	Type
specimen	any
typeName	"object"
details?	Details

Returns

asserts specimen is Record<any, any> | null

Defined in

ses/types.d.ts:146

---

AssertTypeofString

Ƭ AssertTypeofString: (specimen: any, typeName: "string", details?: Details) => asserts specimen is string

Type declaration

▸ (specimen, typeName, details?): asserts specimen is string

Parameters

Name	Type
specimen	any
typeName	"string"
details?	Details

Returns

asserts specimen is string

Defined in

ses/types.d.ts:151

---

AssertTypeofSymbol

Ƭ AssertTypeofSymbol: (specimen: any, typeName: "symbol", details?: Details) => asserts specimen is symbol

Type declaration

▸ (specimen, typeName, details?): asserts specimen is symbol

Parameters

Name	Type
specimen	any
typeName	"symbol"
details?	Details

Returns

asserts specimen is symbol

Defined in

ses/types.d.ts:156

---

AssertTypeofUndefined

Ƭ AssertTypeofUndefined: (specimen: any, typeName: "undefined", details?: Details) => asserts specimen is undefined

Type declaration

▸ (specimen, typeName, details?): asserts specimen is undefined

Parameters

Name	Type
specimen	any
typeName	"undefined"
details?	Details

Returns

asserts specimen is undefined

Defined in

ses/types.d.ts:161

---

Details

Ƭ Details: string | DetailsToken

Defined in

ses/types.d.ts:118

---

DetailsToken

Ƭ DetailsToken: Record<any, never>

Defined in

ses/types.d.ts:117

---

FinalStaticModuleType

Ƭ FinalStaticModuleType: PrecompiledStaticModuleInterface | ThirdPartyStaticModuleInterface

Defined in

ses/types.d.ts:71

---

GenericErrorConstructor

Ƭ GenericErrorConstructor: ErrorConstructor | AggregateErrorConstructor

Defined in

ses/types.d.ts:180

---

Harden

Ƭ Harden: <T>(value: T) => T

File

Types of the SES environment

Type declaration

▸ <T>(value): T

Type parameters

Name
T

Parameters

Name	Type
value	T

Returns

T

Defined in

ses/types.d.ts:20

---

HardenIntrinsics

Ƭ HardenIntrinsics: () => void

Type declaration

▸ (): void

Returns

void

Defined in

ses/types.d.ts:43

---

ImportHook

Ƭ ImportHook: (moduleSpecifier: string) => Promise<StaticModuleType>

Type declaration

▸ (moduleSpecifier): Promise<StaticModuleType>

Parameters

Name	Type
moduleSpecifier	string

Returns

Promise<StaticModuleType>

Defined in

ses/types.d.ts:97

---

Lockdown

Ƭ Lockdown: (options?: LockdownOptions) => void

Type declaration

▸ (options?): void

Parameters

Name	Type
options?	LockdownOptions

Returns

void

Defined in

ses/types.d.ts:44

---

LockdownOptions

Ƭ LockdownOptions: RepairOptions

Defined in

ses/types.d.ts:40

---

MakeAssert

Ƭ MakeAssert: (raise?: Raise, unredacted?: boolean) => Assert

Type declaration

▸ (raise?, unredacted?): Assert

Parameters

Name	Type
raise?	Raise
unredacted?	boolean

Returns

Assert

Defined in

ses/types.d.ts:187

---

ModuleExportsNamespace

Ƭ ModuleExportsNamespace: Record<string, any>

Defined in

ses/types.d.ts:86

---

ModuleMap

Ƭ ModuleMap: Record<string, string | ModuleExportsNamespace>

Defined in

ses/types.d.ts:93

---

ModuleMapHook

Ƭ ModuleMapHook: (moduleSpecifier: string) => string | ModuleExportsNamespace | void

Type declaration

▸ (moduleSpecifier): string | ModuleExportsNamespace | void

Parameters

Name	Type
moduleSpecifier	string

Returns

string | ModuleExportsNamespace | void

Defined in

ses/types.d.ts:94

---

Raise

Ƭ Raise: (reason: Error) => void

Type declaration

▸ (reason): void

Parameters

Name	Type
reason	Error

Returns

void

Defined in

ses/types.d.ts:184

---

RepairIntrinsics

Ƭ RepairIntrinsics: (options?: LockdownOptions) => void

Type declaration

▸ (options?): void

Parameters

Name	Type
options?	LockdownOptions

Returns

void

Defined in

ses/types.d.ts:42

---

ResolveHook

Ƭ ResolveHook: (importSpecifier: string, referrerSpecifier: string) => string

Type declaration

▸ (importSpecifier, referrerSpecifier): string

Parameters

Name	Type
importSpecifier	string
referrerSpecifier	string

Returns

string

Defined in

ses/types.d.ts:89

---

StaticModuleType

Ƭ StaticModuleType: RedirectStaticModuleInterface | FinalStaticModuleType

Defined in

ses/types.d.ts:82

---

Transform

Ƭ Transform: (source: string) => string

Type declaration

▸ (source): string

Parameters

Name	Type
source	string

Returns

string

Defined in

ses/types.d.ts:88

---

__FixedExportMap__

Ƭ __FixedExportMap__: Record<string, [string]>

Defined in

ses/types.d.ts:47

---

__LiveExportMap__

Ƭ __LiveExportMap__: Record<string, [string, boolean]>

Defined in

ses/types.d.ts:46

Variables

lockdown

• Const lockdown: any

Defined in

lockdown/pre.js:14