v5.0.0-rc.3

lavaclient
S
symbol

Variable symbol`Const`

symbol: Schema<string, symbol>

This schema transforms a string into a symbol.

Since

1.0.0

Settings

Member Visibility

Protected
Private
Inherited
External

Theme

Preparing search index...
The search index is not available

lavaclient - v5.0.0-rc.3

Classes
Functions
Type Aliases
Interfaces
Modules
- <internal>
  Classes
  Agent
  Arbitrary
  AsyncResource
  Blob
  ClientRequest
  Duplex
  EventEmitter
  IncomingMessage
  KeyObject
  LavalinkAPI
  LavalinkHttpClient
  LavalinkWSClient
  OutgoingMessage
  PlayerAPI
  Random
  Readable
  Server
  Server
  Server
  Server
  ServerResponse
  SessionAPI
  Socket
  Stream
  Stream
  TLSSocket
  TypedEmitter
  URL
  URLSearchParams
  Value
  WebSocket
  Writable
  X509Certificate
  Variables
  Other
  Emitter
  Emitter
  ReadableByteStreamController
  ReadableStream
  ReadableStreamBYOBReader
  ReadableStreamDefaultController
  ReadableStreamDefaultReader
  TypeId
  TypeId
  WebSocketAlias
  WritableStream
  WritableStreamDefaultController
  WritableStreamDefaultWriter
  error
  message
  typeSymbol
  symbols
  BrandTypeId
  FiberIdTypeId
  RefinedConstructorsTypeId
  RequestTypeId
  Type Aliases
  Other
  AnyRest
  AnySchema
  Args
  ArrayBufferView
  BaseNodeEvents
  BinaryLike
  BufferEncoding
  BufferLike
  BuiltinIteratorReturn
  ComposeFnParam
  DefaultEventMap
  DefaultListener
  DidNotFinish
  Error
  EventMap
  EventMap
  ExecutedLavalinkHttpRequest
  Finish
  Finished
  HasRequest
  InfoKeys
  Key
  KeyFormat
  KeyObjectType
  KeyType
  KeyType
  KeyUsage
  LavalinkHTTPErrorReason
  LavalinkHttpClientEvents
  LavalinkHttpClientRequestEvent
  LavalinkHttpClientStatistics
  LavalinkWSClientEvents
  LavalinkWSClientReconnectFn
  Listener
  ListenerSignature
  LookupFunction
  Message
  OutgoingHttpHeader
  Parameter
  ReadableStreamController
  ReadableStreamReadResult
  ReadableStreamReader
  Rename
  RequestListener
  SecureVersion
  ServerOptions
  SocketConnectOpts
  SocketReadyState
  TypedArray
  typeSymbol
  annotations
  ExamplesAnnotation
  MessageAnnotation
  model
  AST
  LiteralValue
  ParseErrors
  Transformation
  models
  Cause
  Data
  DurationValue
  Either
  Equals
  Exit
  FiberId
  Option
  symbols
  BrandTypeId
  FiberIdTypeId
  RefinedConstructorsTypeId
  RequestTypeId
  types
  Simplify
  UnionToIntersection
  Interfaces
  Other
  AddressInfo
  AgentOptions
  ArrayOptions
  AsymmetricKeyDetails
  AsyncResourceOptions
  BlobOptions
  Certificate
  CipherNameAndProtocol
  ClientRequestArgs
  CommonConnectionOptions
  ConnectOpts
  CryptoKey
  DetailedPeerCertificate
  Dict
  DropArgument
  DuplexOptions
  Element
  EphemeralKeyInfo
  ErrnoException
  EventEmitter
  EventEmitterOptions
  IncomingHttpHeaders
  IndexSignature
  InformationEvent
  IpcSocketConnectOpts
  JsonWebKey
  JwkKeyExportOptions
  KeyAlgorithm
  KeyExportOptions
  KeyObject
  LavalinkHttpClientOptions
  LavalinkHttpRequest
  LavalinkWSClientConnectOptions
  LavalinkWSClientConnectedEvent
  LavalinkWSClientDisconnectedEvent
  LavalinkWSClientOptions
  LavalinkWSClientReadyEvent
  LavalinkWSClientReconnectOptions
  ListenOptions
  LookupAddress
  LookupOptions
  OnReadOpts
  OutgoingHttpHeaders
  ParseError
  ParseResult
  PeerCertificate
  PreparedLavalinkHttpRequest
  PropertySignature
  PxfObject
  QueuingStrategy
  QueuingStrategySize
  RandomGenerator
  ReadOnlyDict
  ReadWriteStream
  ReadableByteStreamController
  ReadableByteStreamControllerCallback
  ReadableOptions
  ReadableStream
  ReadableStream
  ReadableStreamAsyncIterator
  ReadableStreamBYOBReader
  ReadableStreamDefaultController
  ReadableStreamDefaultReader
  ReadableStreamErrorCallback
  ReadableStreamGenericReader
  ReadableStreamGetReaderOptions
  ReadableStreamReadDoneResult
  ReadableStreamReadValueResult
  ReadableWritablePair
  SecureContext
  SecureContextOptions
  ServerOptions
  ServerOpts
  SocketConstructorOpts
  StaticEventEmitterIteratorOptions
  StaticEventEmitterOptions
  StreamPipeOptions
  TLSSocketOptions
  TcpSocketConnectOpts
  TemplateLiteralSpan
  TlsOptions
  TypedEventEmitter
  URLSearchParamsIterator
  UnderlyingByteSource
  UnderlyingSink
  UnderlyingSinkAbortCallback
  UnderlyingSinkCloseCallback
  UnderlyingSinkStartCallback
  UnderlyingSinkWriteCallback
  UnderlyingSource
  UnderlyingSourceCancelCallback
  UnderlyingSourcePullCallback
  UnderlyingSourceStartCallback
  WebSocketAlias
  WritableOptions
  WritableStream
  WritableStream
  WritableStreamDefaultController
  WritableStreamDefaultWriter
  X509CheckOptions
  ZlibOptions
  annotations
  Annotated
  Annotations
  model
  AnyKeyword
  Arbitrary
  BigIntKeyword
  BooleanKeyword
  ComposeTransformation
  Declaration
  Enums
  FinalPropertySignatureTransformation
  FinalTransformation
  Forbidden
  Index
  Key
  Lazy
  Literal
  Missing
  NeverKeyword
  NonEmptyChunk
  NonEmptyIterable
  NumberKeyword
  ObjectKeyword
  ParseOptions
  Pretty
  PropertySignatureTransform
  Refinement
  StringKeyword
  SymbolKeyword
  TemplateLiteral
  Transform
  Tuple
  Type
  TypeLiteral
  TypeLiteralTransformation
  UndefinedKeyword
  Unexpected
  Union
  UnionMember
  UniqueSymbol
  UnknownKeyword
  VoidKeyword
  models
  Brand
  Case
  Chunk
  Composite
  Die
  Duration
  EffectUnify
  EitherUnify
  Empty
  Equal
  ExitUnify
  ExitUnifyIgnore
  Fail
  Failure
  Hash
  Inspectable
  Interrupt
  None
  OptionUnify
  Parallel
  Pipeable
  Predicate
  Refinement
  Request
  Runtime
  Sequential
  Success
  TagUnify
  VarianceStruct
  VarianceStruct
  VarianceStruct
  type class
  Equivalence
  Namespaces
  Brand
  Type Aliases
  models
  Brands
  EnsureCommonBase
  FromConstructor
  Unbranded
  Interfaces
  models
  BrandErrors
  Constructor
  RefinementError
  Case
  Interfaces
  models
  Constructor
  Cause
  Interfaces
  models
  Variance
  Chunk
  Type Aliases
  Infer
  With
  EventEmitter
  Classes
  EventEmitterAsyncResource
  Interfaces
  Abortable
  EventEmitterAsyncResourceOptions
  EventEmitterReferencingAsyncResource
  References
  EventEmitter
  Request
  Type Aliases
  type-level
  Error
  OptionalResult
  Result
  Success
  Interfaces
  models
  Constructor
  Variance
  Stream
  Classes
  PassThrough
  Transform
  Functions
  addAbortSignal
  duplexPair
  finished
  getDefaultHighWaterMark
  isErrored
  isReadable
  pipeline
  setDefaultHighWaterMark
  Type Aliases
  PipelineCallback
  PipelineDestination
  PipelineDestinationIterableFunction
  PipelineDestinationPromiseFunction
  PipelinePromise
  PipelineSource
  PipelineSourceFunction
  PipelineTransform
  PipelineTransformSource
  TransformCallback
  Interfaces
  FinishedOptions
  Pipe
  PipelineOptions
  StreamOptions
  TransformOptions
  Namespaces
  finished
  Functions
  __promisify__
  pipeline
  Functions
  __promisify__
  promises
  Functions
  finished
  pipeline
  Interfaces
  FinishedOptions
  References
  ArrayOptions
  Duplex
  DuplexOptions
  Readable
  ReadableOptions
  Stream
  Writable
  WritableOptions
  WebSocket
  Classes
  Server
  Functions
  createWebSocketStream
  Variables
  WebSocket
  WebSocketServer
  Type Aliases
  CertMeta
  Data
  FinishRequestCallback
  RawData
  VerifyClientCallbackAsync
  VerifyClientCallbackSync
  Interfaces
  AddressInfo
  ClientOptions
  CloseEvent
  ErrorEvent
  Event
  EventListenerOptions
  MessageEvent
  PerMessageDeflateOptions
  ServerOptions
  WebSocket
  WebSocketEventMap
  WebSocketServer
  Enumerations
  LavalinkWSClientState
  References
  BrandErrors
  Constructor
  Unbranded
Namespaces
- S
  Functions
  Chunk transformations
  chunk
  chunkFromSelf
  Data transformations
  data
  dataFromSelf
  Date filters
  validDate
  Date transformations
  dateFromString
  Duration transformations
  durationFromHrTime
  Either transformations
  either
  eitherFromSelf
  Option transformations
  option
  optionFromNullable
  optionFromSelf
  Other
  _default
  from
  optional
  propertySignature
  to
  ReadonlyArray filters
  itemsCount
  maxItems
  minItems
  ReadonlyMap transformations
  readonlyMap
  readonlyMapFromSelf
  ReadonlySet transformations
  readonlySet
  readonlySetFromSelf
  Uint8Array transformations
  uint8ArrayFromNumbers
  annotations
  annotations
  description
  documentation
  equivalence
  examples
  identifier
  jsonSchema
  message
  title
  bigint filters
  betweenBigint
  greaterThanBigint
  greaterThanOrEqualToBigint
  lessThanBigint
  lessThanOrEqualToBigint
  negativeBigint
  nonNegativeBigint
  nonPositiveBigint
  positiveBigint
  bigint transformations
  bigintFromNumber
  bigintFromString
  clampBigint
  boolean transformations
  not
  classes
  Class
  TaggedClass
  TaggedError
  TaggedRequest
  combinators
  array
  attachPropertySignature
  brand
  compose
  element
  extend
  filter
  keyof
  lazy
  mutable
  nonEmptyArray
  nullable
  omit
  optionalElement
  partial
  pick
  record
  required
  rest
  struct
  transform
  transformOrFail
  tuple
  union
  constructors
  declare
  enums
  fromBrand
  instanceOf
  literal
  make
  templateLiteral
  uniqueSymbol
  decoding
  decode
  decodeEither
  decodeOption
  decodePromise
  decodeSync
  encoding
  encode
  encodeEither
  encodeOption
  encodePromise
  encodeSync
  encoding transformations
  base64
  base64url
  hex
  guards
  isSchema
  number filters
  between
  finite
  greaterThan
  greaterThanOrEqualTo
  int
  lessThan
  lessThanOrEqualTo
  multipleOf
  negative
  nonNaN
  nonNegative
  nonPositive
  positive
  number transformations
  clamp
  numberFromString
  parsing
  parse
  parseEither
  parseOption
  parsePromise
  parseSync
  renaming
  rename
  string filters
  endsWith
  includes
  length
  lowercased
  maxLength
  minLength
  nonEmpty
  pattern
  startsWith
  trimmed
  uppercased
  string transformations
  lowercase
  parseJson
  split
  trim
  uppercase
  symbol transformations
  symbolFromString
  validation
  asserts
  is
  validate
  validateEither
  validateOption
  validatePromise
  validateSync
  Variables
  Date constructors
  DateFromSelf
  ValidDate
  ValidDateFromSelf
  Duration constructors
  DurationFromSelf
  Other
  Date
  Duration
  Uint8Array
  null
  undefined
  void
  Uint8Array constructors
  Uint8ArrayFromSelf
  bigint constructors
  BigintFromNumber
  NegativeBigint
  NegativeBigintFromSelf
  NonNegativeBigint
  NonNegativeBigintFromSelf
  NonPositiveBigint
  NonPositiveBigintFromSelf
  PositiveBigint
  PositiveBigintFromSelf
  bigint
  boolean constructors
  Not
  encoding constructors
  Base64
  Base64Url
  Hex
  number constructors
  Finite
  Int
  JsonNumber
  Negative
  NonNaN
  NonNegative
  NonPositive
  NumberFromString
  Positive
  primitives
  any
  bigintFromSelf
  boolean
  never
  number
  object
  string
  symbolFromSelf
  unknown
  string constructors
  NonEmpty
  ParseJson
  Trim
  Trimmed
  ULID
  UUID
  string transformations
  Lowercase
  Uppercase
  symbol constructors
  symbol
  type id
  BetweenBigintTypeId
  BetweenTypeId
  BrandTypeId
  EndsWithTypeId
  FiniteTypeId
  GreaterThanBigintTypeId
  GreaterThanOrEqualToBigintTypeId
  GreaterThanOrEqualToTypeId
  GreaterThanTypeId
  IncludesTypeId
  InstanceOfTypeId
  IntTypeId
  ItemsCountTypeId
  JsonNumberTypeId
  LengthTypeId
  LessThanBigintTypeId
  LessThanOrEqualToBigintTypeId
  LessThanOrEqualToTypeId
  LessThanTypeId
  LowercasedTypeId
  MaxItemsTypeId
  MaxLengthTypeId
  MinItemsTypeId
  MinLengthTypeId
  MultipleOfTypeId
  NonNaNTypeId
  PatternTypeId
  StartsWithTypeId
  TrimmedTypeId
  ULIDTypeId
  UUIDTypeId
  UppercasedTypeId
  ValidDateTypeId
  Type Aliases
  Other
  FromOptionalKeys
  FromStruct
  Join
  Mutable
  StructFields
  ToOptionalKeys
  ToStruct
  symbol
  TypeId
  Interfaces
  Other
  DocAnnotations
  FilterAnnotations
  OptionalPropertySignature
  PropertySignature
  classes
  Class
  model
  BrandSchema
  Schema
  Namespaces
  Other
  Schema
  Type Aliases
  From
  To
  ToAsserts
  Interfaces
  Variance
  classes
  TaggedRequest
  Interfaces
  classes
  Base
  ResultSchemas