Class ACL

constructor

• new ACL(aclData): ACL

• Parameters

  • aclData: ACLData

    construct an instance from the ACL payload

  Returns ACL

Optional admin

denyRead

denyWrite

from

id

Optional meta

ops

read

write

checkOp

• checkOp(op): boolean

• Is an operation allowed

  Parameters

  • op: string

    operation to check

  Returns boolean

getItemsAllowDenyReading

• getItemsAllowDenyReading(): [string[], string[]]

• Constructs allow/deny OID lists (strings), useful for item.state core call

  Returns [string[], string[]]

isAdmin

• isAdmin(): boolean

• Is admin

  Returns boolean

isItemReadable

• isItemReadable(oid): boolean

• Is an item readable

  Parameters

  • oid: OID

    item to check

  Returns boolean

isItemWritable

• isItemWritable(oid): boolean

• Is an item writable

  Parameters

  • oid: OID

    item to check

  Returns boolean

isPvtReadable

• isPvtReadable(path): boolean

• Is a pvt path readable

  Parameters

  • path: string

    pvt path to check

  Returns boolean

isPvtWritable

• isPvtWritable(path): boolean

• Is a pvt path writable

  Parameters

  • path: string

    pvt path to check

  Returns boolean

requireAdmin

• requireAdmin(): void

• Require admin

  Returns void

  Throws

requireItemRead

• requireItemRead(oid): void

• Require an item to be readable

  Parameters

  • oid: OID

    item to check

  Returns void

  Throws

requireItemWrite

• requireItemWrite(oid): void

• Require an item to be writable

  Parameters

  • oid: OID

    item to check

  Returns void

  Throws

requireOp

• requireOp(op): void

• Require an operation

  Parameters

  • op: string

    operation to check

  Returns void

  Throws

requirePvtRead

• requirePvtRead(path): void

• Require a pvt path to be readable

  Parameters

  • path: string

    pvt path to check

  Returns void

  Throws

requirePvtWrite

• requirePvtWrite(path): void

• Require a pvt path to be writable

  Parameters

  • path: string

    pvt path to check

  Returns void

  Throws